Package org.alfresco.repo.copy

Class DefaultCopyBehaviourCallback

java.lang.Object

org.alfresco.repo.copy.AbstractCopyBehaviourCallback

org.alfresco.repo.copy.DefaultCopyBehaviourCallback

All Implemented Interfaces:

CopyBehaviourCallback, Extensible

Direct Known Subclasses:

AliasableAspectCopyBehaviourCallback

@AlfrescoPublicApi
public class DefaultCopyBehaviourCallback
extends AbstractCopyBehaviourCallback
implements Extensible

The default behaviour that a type of aspect implements if there is no associated <behaviour.

This implementation is stateless and therefore thread-safe.

The default behaviour is:

• Must Copy: YES
• Must Cascade: YES, if cascade is on
• Properties to Copy:ALL

Since:

3.2

Author:

Derek Hulley

Nested Class Summary

Nested classes/interfaces inherited from interface org.alfresco.repo.copy.CopyBehaviourCallback

CopyBehaviourCallback.AssocCopySourceAction, CopyBehaviourCallback.AssocCopyTargetAction, CopyBehaviourCallback.ChildAssocCopyAction, CopyBehaviourCallback.ChildAssocRecurseAction, CopyBehaviourCallback.CopyAssociationDetails, CopyBehaviourCallback.CopyChildAssociationDetails

Constructor Summary

Constructors

Constructor	Description
DefaultCopyBehaviourCallback()

Method Summary

Modifier and Type	Method	Description
org.alfresco.util.Pair<CopyBehaviourCallback.AssocCopySourceAction,CopyBehaviourCallback.AssocCopyTargetAction>	getAssociationCopyAction(org.alfresco.service.namespace.QName classQName, CopyDetails copyDetails, CopyBehaviourCallback.CopyAssociationDetails assocCopyDetails)	Default behaviour: * AssocCopySourceAction.COPY_REMOVE_EXISTING * AssocCopyTargetAction.USE_COPIED_OTHERWISE_ORIGINAL_TARGET
CopyBehaviourCallback.ChildAssocCopyAction	getChildAssociationCopyAction(org.alfresco.service.namespace.QName classQName, CopyDetails copyDetails, CopyBehaviourCallback.CopyChildAssociationDetails childAssocCopyDetails)	Default behaviour: Cascade if we are copying children AND the association is primary
java.util.Map<org.alfresco.service.namespace.QName,java.io.Serializable>	getCopyProperties(org.alfresco.service.namespace.QName classQName, CopyDetails copyDetails, java.util.Map<org.alfresco.service.namespace.QName,java.io.Serializable> properties)	Default behaviour: Copy all associated properties
static CopyBehaviourCallback	getInstance()
boolean	getMustCopy(org.alfresco.service.namespace.QName classQName, CopyDetails copyDetails)	Default behaviour: Always copy
<T extends Trait> ExtendedTrait<T>	getTrait(java.lang.Class<? extends T> traitAPI)

Methods inherited from class org.alfresco.repo.copy.AbstractCopyBehaviourCallback

getChildAssociationRecurseAction, isTopLevelCanBeRenamed, recordNodeRefsForRepointing, repointNodeRefs, throwExceptionForUnexpectedBehaviour

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultCopyBehaviourCallback

public DefaultCopyBehaviourCallback()

Method Detail

getInstance

public static CopyBehaviourCallback getInstance()

Returns:

Returns a stateless singleton

getMustCopy

public boolean getMustCopy(org.alfresco.service.namespace.QName classQName,
                           CopyDetails copyDetails)

Default behaviour: Always copy

Specified by:

getMustCopy in interface CopyBehaviourCallback

Parameters:

classQName - the name of the class that this is being invoked for

copyDetails - the source node's copy details for quick reference

Returns:

Returns true always

getAssociationCopyAction

public org.alfresco.util.Pair<CopyBehaviourCallback.AssocCopySourceAction,CopyBehaviourCallback.AssocCopyTargetAction> getAssociationCopyAction(org.alfresco.service.namespace.QName classQName,
                                                                                                                                                      CopyDetails copyDetails,
                                                                                                                                                      CopyBehaviourCallback.CopyAssociationDetails assocCopyDetails)

Default behaviour:
* AssocCopySourceAction.COPY_REMOVE_EXISTING
* AssocCopyTargetAction.USE_COPIED_OTHERWISE_ORIGINAL_TARGET

Specified by:

getAssociationCopyAction in interface CopyBehaviourCallback

Overrides:

getAssociationCopyAction in class AbstractCopyBehaviourCallback

Parameters:

classQName - the name of the class that this is being invoked for

copyDetails - the source node's copy details for quick reference

assocCopyDetails - all other details relating to the association

Returns:

Returns CopyBehaviourCallback.AssocCopySourceAction.COPY_REMOVE_EXISTING and CopyBehaviourCallback.AssocCopyTargetAction.USE_COPIED_TARGET

getChildAssociationCopyAction

public CopyBehaviourCallback.ChildAssocCopyAction getChildAssociationCopyAction(org.alfresco.service.namespace.QName classQName,
                                                                                CopyDetails copyDetails,
                                                                                CopyBehaviourCallback.CopyChildAssociationDetails childAssocCopyDetails)

Default behaviour: Cascade if we are copying children AND the association is primary

Specified by:

getChildAssociationCopyAction in interface CopyBehaviourCallback

Parameters:

classQName - the name of the class that this is being invoked for

copyDetails - the source node's copy details for quick reference

childAssocCopyDetails - all other details relating to the child association

Returns:

Returns true if the association is primary and copyChildren == true

getCopyProperties

public java.util.Map<org.alfresco.service.namespace.QName,java.io.Serializable> getCopyProperties(org.alfresco.service.namespace.QName classQName,
                                                                                                        CopyDetails copyDetails,
                                                                                                        java.util.Map<org.alfresco.service.namespace.QName,java.io.Serializable> properties)

Default behaviour: Copy all associated properties

Specified by:

getCopyProperties in interface CopyBehaviourCallback

Parameters:

classQName - the name of the class that this is being invoked for

copyDetails - the source node's copy details for quick reference

properties - the type- or aspect-specific properties that can be copied. The map can be manipulated and returned as required.

Returns:

Returns all the properties passes in

getTrait

public <T extends Trait> ExtendedTrait<T> getTrait(java.lang.Class<? extends T> traitAPI)

Specified by:

getTrait in interface Extensible