org.xwiki.refactoring.job

Class CreateRequest

java.lang.Object

org.xwiki.job.AbstractRequest

org.xwiki.job.api.AbstractCheckRightsRequest

org.xwiki.refactoring.job.EntityRequest

org.xwiki.refactoring.job.CreateRequest

All Implemented Interfaces:

Serializable, org.xwiki.job.Request

public class CreateRequest
extends EntityRequest

A job request that can be used to create a collection of entities using a specified template.

Since:

7.4M2

Version:

$Id: cfc8ad7a069d6c69fb1f03f8742ec12f379991e8 $

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.xwiki.job.Request

PROPERTY_CONTEXT, PROPERTY_INTERACTIVE, PROPERTY_REMOTE

Constructor Summary

Constructors

Constructor and Description
CreateRequest()

Method Summary

Modifier and Type	Method and Description
List<org.xwiki.model.reference.EntityReference>	getSkippedEntities()
org.xwiki.model.reference.EntityReference	getTemplateReference()
void	setSkippedEntities(List<org.xwiki.model.reference.EntityReference> skippedEntities)
void	setTemplateReference(org.xwiki.model.reference.EntityReference templateReference)

Methods inherited from class org.xwiki.refactoring.job.EntityRequest

getEntityParameters, getEntityReferences, getJobType, isDeep, setDeep, setEntityParameters, setEntityReferences, setJobType

Methods inherited from class org.xwiki.job.api.AbstractCheckRightsRequest

getAuthorReference, getUserReference, isCheckAuthorRights, isCheckRights, setAuthorReference, setCheckAuthorRights, setCheckRights, setUserReference

Methods inherited from class org.xwiki.job.AbstractRequest

containsProperty, equals, getContext, getId, getProperties, getProperty, getProperty, getPropertyNames, hashCode, 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

Constructor Detail

CreateRequest

public CreateRequest()

Method Detail

setTemplateReference

public void setTemplateReference(org.xwiki.model.reference.EntityReference templateReference)

Parameters:

templateReference - the reference of the entity to use as template

getTemplateReference

public org.xwiki.model.reference.EntityReference getTemplateReference()

Returns:

the reference of the entity to use as template

getSkippedEntities

public List<org.xwiki.model.reference.EntityReference> getSkippedEntities()

Returns:

the list of entities that are to be skipped by the job's execution

setSkippedEntities

public void setSkippedEntities(List<org.xwiki.model.reference.EntityReference> skippedEntities)

Parameters:

skippedEntities - the list of entities that to skip in the job's execution