Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.alfresco.repo.copy
Interface CopyServicePolicies.OnCopyNodePolicy
All Superinterfaces:
ClassPolicy, Policy
Enclosing class:
org.alfresco.repo.copy.CopyServicePolicies

@org.alfresco.api.AlfrescoPublicApi
public static interface CopyServicePolicies.OnCopyNodePolicy
extends ClassPolicy
Policy invoked when a node is copied.

Note: Copy policies are used to modify the copy behaviour. Rather than attempt to determine, up front, the behaviour that applies for all types and aspects, the callbacks are used to lazily adjust the behaviour.

Implementing this policy is particularly important if aspects want to partake in the copy process. The behaviour can change whether or not the aspect is copied and which of the properties to carry to the new node.

If no behaviour is registered or no callback is given, then the default behaviour is assumed. Several pre-defined behaviours exist to simplify the callbacks, including:

The DefaultCopyBehaviourCallback is probably the best starting point for further callback implementations; overriding the class allows the behaviour to be overridden, provided that this policy method is implemented.

Note: A 'class' is either a type or an aspect.


Field Summary
org.alfresco.repo.policy.Policy.Arg
ARG_0
org.alfresco.repo.policy.Policy.Arg
ARG_1
QNAME
Fields inherited from interface org.alfresco.repo.policy.Policy
NAMESPACE
Method Summary
org.alfresco.repo.copy.CopyBehaviourCallback
getCopyCallback(QName classRef, CopyDetails copyDetails)
          Called for all types and aspects before copying a node.
Field Detail
ARG_0
public static final org.alfresco.repo.policy.Policy.Arg ARG_0

ARG_1
public static final org.alfresco.repo.policy.Policy.Arg ARG_1

QNAME
public static final QName QNAME
Method Detail
getCopyCallback
org.alfresco.repo.copy.CopyBehaviourCallback getCopyCallback(QName classRef,
                                                             CopyDetails copyDetails)
Called for all types and aspects before copying a node.
Parameters:
classRef - the type or aspect qualified name
copyDetails - the details of the impending copy
Returns:
Return the callback that will be used to modify the copy behaviour for this dictionary class. Return null to assume the default.
Since:
V3.2
See Also:
CopyServicePolicies

Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

Copyright © 2005–2018 Alfresco Software. All rights reserved.

Java API documentation generated with DocFlex/Javadoc 1.6.1 using JavadocPro template set.