Package org.xwiki.refactoring.job

Class 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: 11b0308b3c68b6e12831567a71f56c7f14a77c62 $
    See Also:
    Serialized Form

    • Constructor Detail

      • AbstractCopyOrMoveRequest

        public AbstractCopyOrMoveRequest()
        Default constructor.

      • AbstractCopyOrMoveRequest

        protected AbstractCopyOrMoveRequest​(org.xwiki.job.Request request)
        Parameters:
        request - the request to copy
        Since:
        14.7RC1, 14.4.4, 13.10.9

    • 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

        @Deprecated(since="14.8RC1")
public boolean isUpdateLinksOnFarm()
        Deprecated.
        not taken into account anymore
        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

        @Deprecated(since="14.8RC1")
public void setUpdateLinksOnFarm​(boolean updateLinksOnFarm)
        Deprecated.
        not taken into account anymore
        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