org.xwiki.refactoring.job

Class AbstractCopyOrMoveRequest

java.lang.Object

org.xwiki.job.AbstractRequest

org.xwiki.job.api.AbstractCheckRightsRequest

org.xwiki.refactoring.job.EntityRequest

org.xwiki.refactoring.job.AbstractCopyOrMoveRequest

All Implemented Interfaces:

Serializable, org.xwiki.job.Request

Direct Known Subclasses:

CopyRequest, MoveRequest

public abstract class AbstractCopyOrMoveRequest
extends EntityRequest

Represents a request used for Copy, Move or Rename (though Move).

Since:

10.11RC1

Version:

$Id: 7b72f43c42fab31b77d2e65c84f20a73fd8de757 $

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
AbstractCopyOrMoveRequest()

Method Summary

Modifier and Type	Method and Description
org.xwiki.model.reference.EntityReference	getDestination()
boolean	isUpdateLinks()
boolean	isUpdateLinksOnFarm()
void	setDestination(org.xwiki.model.reference.EntityReference destination) Sets the destination entity, where to move the entities specified by EntityRequest.getEntityReferences().
void	setUpdateLinks(boolean updateLinks) Sets whether the links that target the old entity reference (before the move) should be updated to target the new reference (after the move) or not.
void	setUpdateLinksOnFarm(boolean updateLinksOnFarm) Sets whether the job should update the links that target the old entity reference (before the move) from anywhere on the farm, or only from the wiki where the entity was located before the mode.

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

AbstractCopyOrMoveRequest

public AbstractCopyOrMoveRequest()

Method Detail

getDestination

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

Returns:

the destination entity, where to move the entities specified by EntityRequest.getEntityReferences()

setDestination

public void setDestination(org.xwiki.model.reference.EntityReference destination)

Sets the destination entity, where to move the entities specified by EntityRequest.getEntityReferences().

Parameters:

destination - the destination entity

isUpdateLinks

public boolean isUpdateLinks()

Returns:

true if the links that target the old entity reference (before the move) should be updated to target the new reference (after the move), false to preserve the old link target

setUpdateLinks

public void setUpdateLinks(boolean updateLinks)

Sets whether the links that target the old entity reference (before the move) should be updated to target the new reference (after the move) or not.

Parameters:

updateLinks - true to update the links, false to preserve the old link target

isUpdateLinksOnFarm

public boolean isUpdateLinksOnFarm()

Returns:

true if the job should update the links that target the old entity reference (before the move) from anywhere on the farm, false if the job should update only the links from the wiki where the entity was located before the move

setUpdateLinksOnFarm

public void setUpdateLinksOnFarm(boolean updateLinksOnFarm)

Sets whether the job should update the links that target the old entity reference (before the move) from anywhere on the farm, or only from the wiki where the entity was located before the mode.

Note that this parameter has no effect if isUpdateLinks() is false.

Parameters:

updateLinksOnFarm - true to update the links from anywhere on the farm, false to update only the links from the wiki where the entity is located