Package org.xwiki.refactoring.job

Class EntityRequest

java.lang.Object

org.xwiki.job.AbstractRequest

org.xwiki.job.api.AbstractCheckRightsRequest

org.xwiki.refactoring.job.EntityRequest

All Implemented Interfaces:

Serializable, org.xwiki.job.Request

Direct Known Subclasses:

AbstractCopyOrMoveRequest, CreateRequest, DeleteRequest, ReplaceUserRequest

public class EntityRequest
extends AbstractCheckRightsRequest

A generic job request that targets multiple entities.

Since:

7.2M1

Version:

$Id: f82ca017f4aad697093ea0be7e46e2501ffb6744 $

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.xwiki.job.Request

PROPERTY_CONTEXT, PROPERTY_INTERACTIVE, PROPERTY_REMOTE

Constructor Summary

Constructors

Constructor	Description
EntityRequest()	Default constructor.
EntityRequest(org.xwiki.job.Request request)

Method Summary

Modifier and Type	Method	Description
Map<String,String>	getEntityParameters(org.xwiki.model.reference.EntityReference entityReference)
Collection<org.xwiki.model.reference.EntityReference>	getEntityReferences()
String	getJobType()	Deprecated. since 9.2RC1, use AbstractJobStatus.getJobType() instead
boolean	isDeep()
void	setDeep(boolean deep)	Sets whether the operation should target child entities also (i.e.
void	setEntityParameters(org.xwiki.model.reference.EntityReference entityReference, Map<String,String> entityParameters)	Associates custom parameters to a target entity.
void	setEntityReferences(Collection<org.xwiki.model.reference.EntityReference> entityReferences)	Sets the collection of entity references that are targeted by this request.
void	setJobType(String jobType)	Deprecated.

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

EntityRequest

public EntityRequest()

Default constructor.

EntityRequest

public EntityRequest(org.xwiki.job.Request request)

Parameters:

request - the request to copy

Since:

14.7RC1, 14.4.4, 13.10.9

Method Detail

getJobType

@Deprecated
public String getJobType()

Deprecated.

since 9.2RC1, use AbstractJobStatus.getJobType() instead

Returns:

the type of job that should perform this request; this is useful when different jobs use the same type of request

setJobType

@Deprecated
public void setJobType(String jobType)

Deprecated.

Sets the type of job that should perform this request. This is useful when different jobs use the same type of request.

Parameters:

jobType - the type of job that should perform this request

getEntityReferences

public Collection<org.xwiki.model.reference.EntityReference> getEntityReferences()

Returns:

the collection of entity references that are targeted by this request

setEntityReferences

public void setEntityReferences(Collection<org.xwiki.model.reference.EntityReference> entityReferences)

Sets the collection of entity references that are targeted by this request.

Parameters:

entityReferences - a collection of entity references

isDeep

public boolean isDeep()

Returns:

true if the operation should target child entities also (i.e. go deep into the entity hierarchy), false otherwise

setDeep

public void setDeep(boolean deep)

Sets whether the operation should target child entities also (i.e. go deep into the entity hierarchy) or not.

Parameters:

deep - true to include the child entities, false otherwise

getEntityParameters

public Map<String,String> getEntityParameters(org.xwiki.model.reference.EntityReference entityReference)

Parameters:

entityReference - one of the entity references that are the target of this request

Returns:

the custom parameters associated to the specified target entity

setEntityParameters

public void setEntityParameters(org.xwiki.model.reference.EntityReference entityReference,
                                Map<String,String> entityParameters)

Associates custom parameters to a target entity.

Parameters:

entityReference - one of the target entities

entityParameters - the custom parameters to associate to the specified target entity