Package org.alfresco.repo.rule

Class RulesAspect

java.lang.Object

org.alfresco.repo.rule.RulesAspect

All Implemented Interfaces:

CopyServicePolicies.OnCopyCompletePolicy, CopyServicePolicies.OnCopyNodePolicy, NodeServicePolicies.BeforeDeleteNodePolicy, NodeServicePolicies.BeforeRemoveAspectPolicy, NodeServicePolicies.OnAddAspectPolicy, ClassPolicy, Policy

public class RulesAspect
extends Object
implements CopyServicePolicies.OnCopyNodePolicy, CopyServicePolicies.OnCopyCompletePolicy, NodeServicePolicies.OnAddAspectPolicy, NodeServicePolicies.BeforeRemoveAspectPolicy, NodeServicePolicies.BeforeDeleteNodePolicy

Class containing behaviour for the rules aspect

Author:

Roy Wetherall

Nested Class Summary

Nested classes/interfaces inherited from interface org.alfresco.repo.policy.Policy

Policy.Arg

Field Summary

Fields inherited from interface org.alfresco.repo.copy.CopyServicePolicies.OnCopyCompletePolicy

QNAME

Fields inherited from interface org.alfresco.repo.copy.CopyServicePolicies.OnCopyNodePolicy

ARG_0, ARG_1, QNAME

Fields inherited from interface org.alfresco.repo.node.NodeServicePolicies.BeforeDeleteNodePolicy

QNAME

Fields inherited from interface org.alfresco.repo.node.NodeServicePolicies.BeforeRemoveAspectPolicy

QNAME

Fields inherited from interface org.alfresco.repo.node.NodeServicePolicies.OnAddAspectPolicy

QNAME

Fields inherited from interface org.alfresco.repo.policy.Policy

NAMESPACE

Constructor Summary

Constructors

Constructor	Description
RulesAspect()

Method Summary

Modifier and Type	Method	Description
void	beforeDeleteNode(NodeRef nodeRef)	author Neil McErlean
void	beforeRemoveAspect(NodeRef nodeRef, QName aspectTypeQName)	The rule folder & below will be deleted automatically in the normal way, so we don't need to worry about them.
CopyBehaviourCallback	getCopyCallback(QName classRef, CopyDetails copyDetails)	Called for all types and aspects before copying a node.
void	init()
void	onAddAspect(NodeRef nodeRef, QName aspectTypeQName)	Creates the rules folder below the node
void	onCopyComplete(QName classRef, NodeRef sourceNodeRef, NodeRef destinationRef, boolean copyToNewNode, Map<NodeRef,NodeRef> copyMap)	Re-enable aspect behaviour for the source node
void	setBehaviourFilter(BehaviourFilter behaviourFilter)
void	setNodeService(NodeService nodeService)
void	setPolicyComponent(PolicyComponent policyComponent)
void	setRuleService(RuleService ruleService)

Methods inherited from class java.lang.Object

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

Constructor Details

RulesAspect

public RulesAspect()

Method Details

setPolicyComponent

public void setPolicyComponent(PolicyComponent policyComponent)

setBehaviourFilter

public void setBehaviourFilter(BehaviourFilter behaviourFilter)

setNodeService

public void setNodeService(NodeService nodeService)

setRuleService

public void setRuleService(RuleService ruleService)

init

public void init()

onAddAspect

public void onAddAspect(NodeRef nodeRef,
 QName aspectTypeQName)

Creates the rules folder below the node

Specified by:

onAddAspect in interface NodeServicePolicies.OnAddAspectPolicy

Parameters:

nodeRef - the node to which the aspect was added

aspectTypeQName - the type of the aspect

beforeRemoveAspect

public void beforeRemoveAspect(NodeRef nodeRef,
 QName aspectTypeQName)

The rule folder & below will be deleted automatically in the normal way, so we don't need to worry about them. But we need additional handling for any other folders which have rules linked to this folder's rules. See ALF-11923, ALF-15262.

Specified by:

beforeRemoveAspect in interface NodeServicePolicies.BeforeRemoveAspectPolicy

Parameters:

nodeRef - the node from which the aspect will be removed

aspectTypeQName - the type of the aspect

See Also:

• NodeServicePolicies.BeforeRemoveAspectPolicy.beforeRemoveAspect(org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.namespace.QName)

beforeDeleteNode

public void beforeDeleteNode(NodeRef nodeRef)

author Neil McErlean

Specified by:

beforeDeleteNode in interface NodeServicePolicies.BeforeDeleteNodePolicy

Parameters:

nodeRef - the node reference

Since:

3.4.11

getCopyCallback

public CopyBehaviourCallback getCopyCallback(QName classRef,
 CopyDetails copyDetails)

Description copied from interface: CopyServicePolicies.OnCopyNodePolicy

Called for all types and aspects before copying a node.

Specified by:

getCopyCallback in interface CopyServicePolicies.OnCopyNodePolicy

Parameters:

classRef - the type or aspect qualified name

copyDetails - the details of the impending copy

Returns:

Returns CopyBehaviourCallback

See Also:

• CopyServicePolicies

onCopyComplete

public void onCopyComplete(QName classRef,
 NodeRef sourceNodeRef,
 NodeRef destinationRef,
 boolean copyToNewNode,
 Map<NodeRef,NodeRef> copyMap)

Re-enable aspect behaviour for the source node

Specified by:

onCopyComplete in interface CopyServicePolicies.OnCopyCompletePolicy

Parameters:

classRef - the type of the node that was copied

sourceNodeRef - the original node

destinationRef - the destination node

copyMap - a map containing all the nodes that have been created during the copy