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

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

Base class for Request implementations used by wiki provisioners.

Since:

5.3M2

Version:

$Id: d66215b3a5a25257995eea40c9f9f21f02d1560f $

See Also:

Serialized Form

Field Summary

static String	PROPERTY_PROVISIONING_JOB_PARAMETER Name of the property that stores the property used by the provisioning job.
static String	PROPERTY_WIKI_ID Name of the property that stores the id of the wiki to provision.

Fields inherited from interface org.xwiki.job.Request

PROPERTY_INTERACTIVE, PROPERTY_REMOTE

Constructor Summary

WikiProvisioningJobRequest(List<String> id, String wikiId, Object parameter)
Constructor.

Method Summary

boolean	equals(Object o)
Object	getProvisioningJobParameter()
String	getWikiId()
int	hashCode()
void	setProvisioningJobParameter(Object parameter)
void	setWikiId(String wikiId)

Methods inherited from class org.xwiki.job.AbstractRequest

containsProperty, getId, getProperty, getProperty, getPropertyNames, isInteractive, isRemote, isVerbose, removeProperty, setId, setId, setInteractive, setProperty, setRemote, 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

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

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

See Also:

Constant Field Values

Constructor Detail

WikiProvisioningJobRequest

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

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

Method Detail

setWikiId

public void setWikiId(String wikiId)

Parameters:

wikiId - if of the wiki to provision

getWikiId

public String getWikiId()

Returns:

the id of the wiki to provision

setProvisioningJobParameter

public void setProvisioningJobParameter(Object parameter)

Parameters:

parameter - the parameter to be used by the provisioning job

getProvisioningJobParameter

public Object getProvisioningJobParameter()

Returns:

the parameter to be used by the provisioning job

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object