Package org.alfresco.service.cmr.rule

Interface RuleType

All Known Implementing Classes:

RuleTypeImpl

public interface RuleType

Rule type interface.

Author:

Roy Wetherall

Field Summary

Fields

Modifier and Type	Field	Description
static String	INBOUND	Some rule type constants
static String	OUTBOUND
static String	UPDATE

Method Summary

Modifier and Type	Method	Description
String	getDisplayLabel()	Get the display label of the rule type.
String	getName()	Get the name of the rule type.
void	triggerRuleType(org.alfresco.service.cmr.repository.NodeRef nodeRef, org.alfresco.service.cmr.repository.NodeRef actionedUponNodeRef, boolean executeRuleImmediately)	Trigger the rules of the rule type for the node on the actioned upon node.

Field Detail

INBOUND

static final String INBOUND

Some rule type constants

See Also:

Constant Field Values

UPDATE

static final String UPDATE

See Also:

Constant Field Values

OUTBOUND

static final String OUTBOUND

See Also:

Constant Field Values

Method Detail

getName

String getName()

Get the name of the rule type.

The name is unique and is used to identify the rule type.

Returns:

the name of the rule type

getDisplayLabel

String getDisplayLabel()

Get the display label of the rule type.

Returns:

the display label

triggerRuleType

void triggerRuleType(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                     org.alfresco.service.cmr.repository.NodeRef actionedUponNodeRef,
                     boolean executeRuleImmediately)

Trigger the rules of the rule type for the node on the actioned upon node.

Parameters:

nodeRef - the node ref whos rule of rule type are to be triggered

actionedUponNodeRef - the node ref that the triggered rule will action upon

executeRuleImmediately - indicates whether the rule should be executed immediately or not