org.drools.spi
Interface Activation

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

Queueable

All Known Implementing Classes:

AgendaItem, ScheduledAgendaItem

public interface Activation
extends java.io.Serializable

When a Tuple fully matches a rule it is added to the Agenda As an Activation. Each Activation is assigned a number, this number is determined by the WorkingMemory all Activations created from a single insert, update, retract are assgigned the same Activation number.

Author:

Mark Proctor, Bob McWhirter

Method Summary

void	addLogicalDependency(LogicalDependency node)
ActivationGroupNode	getActivationGroupNode()
long	getActivationNumber() Retrieve the activation number.
AgendaGroup	getAgendaGroup()
LinkedList	getLogicalDependencies()
PropagationContext	getPropagationContext() Retrieve the PropagationContext for the Activation
Rule	getRule() Retrieve the Rule that was activated.
RuleFlowGroupNode	getRuleFlowGroupNode()
int	getSalience()
GroupElement	getSubRule() Retrieve the subrule that was activated.
Tuple	getTuple() Retrieve the Tuple that was activated.
boolean	isActivated()
void	remove() Cancel the Activation by removing it from the Agenda.
void	setActivated(boolean activated)
void	setActivationGroupNode(ActivationGroupNode activationGroupNode)
void	setLogicalDependencies(LinkedList justified)
void	setRuleFlowGroupNode(RuleFlowGroupNode ruleFlowGroupNode)

Method Detail

getRule

Rule getRule()

Retrieve the Rule that was activated.

Returns:

The rule.

getSalience

int getSalience()

getSubRule

GroupElement getSubRule()

Retrieve the subrule that was activated.

Returns:

getTuple

Tuple getTuple()

Retrieve the Tuple that was activated.

Returns:

The tuple.

getPropagationContext

PropagationContext getPropagationContext()

Retrieve the PropagationContext for the Activation

Returns:

The propagation context

getActivationNumber

long getActivationNumber()

Retrieve the activation number.

Returns:

The activation number

remove

void remove()

Cancel the Activation by removing it from the Agenda.

addLogicalDependency

void addLogicalDependency(LogicalDependency node)

getLogicalDependencies

LinkedList getLogicalDependencies()

setLogicalDependencies

void setLogicalDependencies(LinkedList justified)

isActivated

boolean isActivated()

setActivated

void setActivated(boolean activated)

getAgendaGroup

AgendaGroup getAgendaGroup()

getActivationGroupNode

ActivationGroupNode getActivationGroupNode()

setActivationGroupNode

void setActivationGroupNode(ActivationGroupNode activationGroupNode)

getRuleFlowGroupNode

RuleFlowGroupNode getRuleFlowGroupNode()

setRuleFlowGroupNode

void setRuleFlowGroupNode(RuleFlowGroupNode ruleFlowGroupNode)