Class PageCopyRequest


  • public class PageCopyRequest
    extends Object
    Request for a batch copy call
    • Field Detail

      • createCopy

        protected boolean createCopy
        Flag that indicates whether to create a new page when an existing page with the same filename was found in the target folder. By default no copy will be created. In this case the found page id would be returned by the response.
      • nodeId

        protected Integer nodeId
        Node ID for the source pages
      • sourcePageIds

        protected List<Integer> sourcePageIds
        List of pages id's that should be copied
      • targetFolders

        protected List<TargetFolder> targetFolders
        List of target folders in which the pages should be copied.
    • Constructor Detail

      • PageCopyRequest

        public PageCopyRequest()
    • Method Detail

      • getTargetFolders

        public List<TargetFolder> getTargetFolders()
        The list of target folder in which the pages should be copied.
        Returns:
        List of target folder entries
      • getSourcePageIds

        public List<Integer> getSourcePageIds()
        The list of source page id's that should be copied to the target folders.
        Returns:
        List of source page id's
      • setSourcePageIds

        public void setSourcePageIds​(List<Integer> sourcePageIds)
        Set the list of source page id's.
        Parameters:
        sourcePageIds -
      • setTargetFolders

        public void setTargetFolders​(List<TargetFolder> targetFolders)
        Set the target folders into which the pages should be copied.
        Parameters:
        targetFolders -
      • isCreateCopy

        public boolean isCreateCopy()
        Whether new copies should be created in folders in which already pages with the same name reside.
        Returns:
        true, when the create copy flag is set and new copies should be created. Otherwise false.
      • setCreateCopy

        public void setCreateCopy​(boolean createCopy)
        Set the create copy flag. A new page will be created in the target folder even when an existing page with the same name was found that folder. This applies for all target folders.
        Parameters:
        createCopy -
      • getNodeId

        public Integer getNodeId()
        Node ID for the source pages. If this is set to a channel, the channel variant of the given page will be copied.
        Returns:
        node ID for the source pages
      • setNodeId

        public void setNodeId​(Integer nodeId)
        Set the node ID
        Parameters:
        nodeId - node ID