Package org.alfresco.service.cmr.transfer

Class TransferDefinition

  • All Implemented Interfaces:
    java.io.Serializable
    public class TransferDefinition
extends java.lang.Object
implements java.io.Serializable
    Definition of what to transfer. nodes Specifies which node to transfer

    isSync specifies whether the list of nodes is to be sync'ed. If sync then the transfer machinery can determine by the absence of a node or association in the transfer that the missing nodes should be deleted on the destination. Else with a non sync transfer then the archive node ref is required to remote a node on the destination.

    See Also:
    Serialized Form

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.Set<org.alfresco.service.namespace.QName> getExcludedAspects()
      Gets the aspects to exclude from transfer
      java.util.Set<org.alfresco.service.cmr.repository.NodeRef> getNodes()
      Get which nodes to transfer
      java.util.Set<org.alfresco.service.cmr.repository.NodeRef> getNodesToRemove()
      Get the list of nodes that are to be explicitly removed from the target repository
      boolean isReadOnly()
      isReadOnly specifies whether the transferred nodes should be editable on the destination system.
      boolean isSync()
      isSync specifies whether the list of nodes is to be sync'ed.
      void setExcludedAspects​(java.util.Collection<org.alfresco.service.namespace.QName> excludedAspects)
      Sets which aspects to exclude from transfer
      void setExcludedAspects​(org.alfresco.service.namespace.QName... excludedAspects)
      Sets which aspects to exclude from transfer
      void setNodes​(java.util.Collection<org.alfresco.service.cmr.repository.NodeRef> nodes)
      Set which nodes to transfer
      void setNodes​(org.alfresco.service.cmr.repository.NodeRef... nodes)  
      void setNodesToRemove​(java.util.Collection<org.alfresco.service.cmr.repository.NodeRef> nodes)
      Set nodes that are to be explicitly removed from the the target repository
      void setNodesToRemove​(org.alfresco.service.cmr.repository.NodeRef... nodes)
      Set nodes that are to be explicitly removed from the the target repository
      void setReadOnly​(boolean isReadOnly)
      isReadOnly specifies whether the transferred nodes should be editable on the destination system.
      void setSync​(boolean isSync)
      isSync specifies whether the list of nodes is to be sync'ed.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • TransferDefinition

        public TransferDefinition()

    • Method Detail

      • setNodes

        public void setNodes​(java.util.Collection<org.alfresco.service.cmr.repository.NodeRef> nodes)
        Set which nodes to transfer

      • setNodes

        public void setNodes​(org.alfresco.service.cmr.repository.NodeRef... nodes)

      • setNodesToRemove

        public void setNodesToRemove​(java.util.Collection<org.alfresco.service.cmr.repository.NodeRef> nodes)
        Set nodes that are to be explicitly removed from the the target repository

      • setNodesToRemove

        public void setNodesToRemove​(org.alfresco.service.cmr.repository.NodeRef... nodes)
        Set nodes that are to be explicitly removed from the the target repository
        Parameters:
        nodes - NodeRef...

      • getNodes

        public java.util.Set<org.alfresco.service.cmr.repository.NodeRef> getNodes()
        Get which nodes to transfer

      • getNodesToRemove

        public java.util.Set<org.alfresco.service.cmr.repository.NodeRef> getNodesToRemove()
        Get the list of nodes that are to be explicitly removed from the target repository

      • setExcludedAspects

        public void setExcludedAspects​(java.util.Collection<org.alfresco.service.namespace.QName> excludedAspects)
        Sets which aspects to exclude from transfer
        Parameters:
        excludedAspects - collection of aspects to exclude

      • setExcludedAspects

        public void setExcludedAspects​(org.alfresco.service.namespace.QName... excludedAspects)
        Sets which aspects to exclude from transfer
        Parameters:
        excludedAspects - aspects to exclude from transfer

      • getExcludedAspects

        public java.util.Set<org.alfresco.service.namespace.QName> getExcludedAspects()
        Gets the aspects to exclude from transfer
        Returns:
        set of excluded aspects (or null, if none specified)

      • setSync

        public void setSync​(boolean isSync)
        isSync specifies whether the list of nodes is to be sync'ed. If sync then the transfer machinery can determine by the absence of a node or association in the transfer that the missing nodes should be deleted on the destination. Else with a non sync transfer then the archive node ref is required to remote a node on the destination.

      • isSync

        public boolean isSync()
        isSync specifies whether the list of nodes is to be sync'ed. If sync then the transfer machinery can determine by the absence of a node or association in the transfer that missing nodes should be deleted on the destination. Else with a non sync transfer then the archive node ref is required to remote a node on the destination.
        Returns:
        true if the transfer is in "sync" mode.

      • setReadOnly

        public void setReadOnly​(boolean isReadOnly)
        isReadOnly specifies whether the transferred nodes should be editable on the destination system.

      • isReadOnly

        public boolean isReadOnly()
        isReadOnly specifies whether the transferred nodes should be editable on the destination system.