org.alfresco.service.cmr.transfer

Class TransferDefinition

java.lang.Object

org.alfresco.service.cmr.transfer.TransferDefinition

All Implemented Interfaces:

Serializable

public class TransferDefinition
extends Object
implements 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

Constructor Summary

Constructors

Constructor and Description
TransferDefinition()

Method Summary

Modifier and Type	Method and Description
Set<QName>	getExcludedAspects() Gets the aspects to exclude from transfer
Set<NodeRef>	getNodes() Get which nodes to transfer
Set<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(Collection<QName> excludedAspects) Sets which aspects to exclude from transfer
void	setExcludedAspects(QName... excludedAspects) Sets which aspects to exclude from transfer
void	setNodes(Collection<NodeRef> nodes) Set which nodes to transfer
void	setNodes(NodeRef... nodes)
void	setNodesToRemove(Collection<NodeRef> nodes) Set nodes that are to be explicitly removed from the the target repository
void	setNodesToRemove(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(Collection<NodeRef> nodes)

Set which nodes to transfer

setNodes

public void setNodes(NodeRef... nodes)

setNodesToRemove

public void setNodesToRemove(Collection<NodeRef> nodes)

Set nodes that are to be explicitly removed from the the target repository

setNodesToRemove

public void setNodesToRemove(NodeRef... nodes)

Set nodes that are to be explicitly removed from the the target repository

Parameters:

nodes - NodeRef...

getNodes

public Set<NodeRef> getNodes()

Get which nodes to transfer

getNodesToRemove

public Set<NodeRef> getNodesToRemove()

Get the list of nodes that are to be explicitly removed from the target repository

setExcludedAspects

public void setExcludedAspects(Collection<QName> excludedAspects)

Sets which aspects to exclude from transfer

Parameters:

excludedAspects - collection of aspects to exclude

setExcludedAspects

public void setExcludedAspects(QName... excludedAspects)

Sets which aspects to exclude from transfer

Parameters:

excludedAspects - aspects to exclude from transfer

getExcludedAspects

public Set<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.