Package org.xwiki.wiki.provisioning

Class WikiProvisioningJobRequest

java.lang.Object

org.xwiki.job.AbstractRequest

org.xwiki.wiki.provisioning.WikiProvisioningJobRequest

All Implemented Interfaces:

Serializable, org.xwiki.job.Request

@Deprecated
public class WikiProvisioningJobRequest
extends org.xwiki.job.AbstractRequest

Deprecated.

since 7.0M2

Base class for Request implementations used by wiki provisioners.

Since:

5.3M2

Version:

$Id: 4238dd46d2a849ee78f633991c0d20fd3d52408e $

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	PROPERTY_PROVISIONING_JOB_PARAMETER	Deprecated. Name of the property that stores the property used by the provisioning job.
static String	PROPERTY_PROVISIONING_USER	Deprecated. Name of the property that stores the user that is provisioning the wiki.
static String	PROPERTY_WIKI_ID	Deprecated. Name of the property that stores the id of the wiki to provision.

Fields inherited from interface org.xwiki.job.Request

PROPERTY_CONTEXT, PROPERTY_INTERACTIVE, PROPERTY_REMOTE

Constructor Summary

Constructors

Constructor	Description
WikiProvisioningJobRequest(List<String> id, String wikiId, Object parameter)	Deprecated. use WikiProvisioningJobRequest(List, String, Object, DocumentReference)
WikiProvisioningJobRequest(List<String> id, String wikiId, Object parameter, DocumentReference provisioningUser)	Deprecated. Constructor.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)	Deprecated.
Object	getProvisioningJobParameter()	Deprecated.
DocumentReference	getProvisioningUser()	Deprecated.
String	getWikiId()	Deprecated.
int	hashCode()	Deprecated.
void	setProvisioningJobParameter(Object parameter)	Deprecated.
void	setProvisioningUser(DocumentReference userReference)	Deprecated.
void	setWikiId(String wikiId)	Deprecated.

Methods inherited from class org.xwiki.job.AbstractRequest

containsProperty, getContext, getId, getProperties, getProperty, getProperty, getPropertyNames, isInteractive, isRemote, isStatusLogIsolated, isStatusSerialized, isVerbose, removeProperty, setContext, setId, setId, setId, setInteractive, setProperty, setRemote, setStatusLogIsolated, setStatusSerialized, setVerbose

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

PROPERTY_WIKI_ID

public static final String PROPERTY_WIKI_ID

Deprecated.

Name of the property that stores the id of the wiki to provision.

See Also:

Constant Field Values

PROPERTY_PROVISIONING_JOB_PARAMETER

public static final String PROPERTY_PROVISIONING_JOB_PARAMETER

Deprecated.

Name of the property that stores the property used by the provisioning job.

See Also:

Constant Field Values

PROPERTY_PROVISIONING_USER

public static final String PROPERTY_PROVISIONING_USER

Deprecated.

Name of the property that stores the user that is provisioning the wiki.

See Also:

Constant Field Values

Constructor Detail

WikiProvisioningJobRequest

@Deprecated
public WikiProvisioningJobRequest(List<String> id,
                                  String wikiId,
                                  Object parameter)

Deprecated.

use WikiProvisioningJobRequest(List, String, Object, DocumentReference)

Constructor.

Parameters:

id - id of the job request

wikiId - id of the wiki to provision

parameter - the parameter to be used by the provisioning job

WikiProvisioningJobRequest

public WikiProvisioningJobRequest(List<String> id,
                                  String wikiId,
                                  Object parameter,
                                  DocumentReference provisioningUser)

Deprecated.

Constructor.

Parameters:

id - id of the job request

wikiId - id of the wiki to provision

parameter - the parameter to be used by the provisioning job

provisioningUser - the user who executes the provisioning job

Since:

6.3M1

Method Detail

setWikiId

public void setWikiId(String wikiId)

Deprecated.

Parameters:

wikiId - if of the wiki to provision

getWikiId

public String getWikiId()

Deprecated.

Returns:

the id of the wiki to provision

setProvisioningJobParameter

public void setProvisioningJobParameter(Object parameter)

Deprecated.

Parameters:

parameter - the parameter to be used by the provisioning job

getProvisioningJobParameter

public Object getProvisioningJobParameter()

Deprecated.

Returns:

the parameter to be used by the provisioning job

setProvisioningUser

public void setProvisioningUser(DocumentReference userReference)

Deprecated.

Parameters:

userReference - the user who executes the provisioning job

Since:

6.3M1

getProvisioningUser

public DocumentReference getProvisioningUser()

Deprecated.

Returns:

the user who executes the provisioning job

Since:

6.3M1

equals

public boolean equals(Object o)

Deprecated.

Overrides:

equals in class org.xwiki.job.AbstractRequest

hashCode

public int hashCode()

Deprecated.

Overrides:

hashCode in class org.xwiki.job.AbstractRequest