org.drools.core.common
Interface AgendaItem

All Superinterfaces:

Activation, org.kie.api.runtime.rule.Match, Serializable

All Known Implementing Classes:

AgendaItemImpl, RuleAgendaItem, RuleTerminalNodeLeftTuple, ScheduledAgendaItem

public interface AgendaItem
extends Activation

Method Summary

void	addBlocked(LogicalDependency dep)
void	addLogicalDependency(LogicalDependency node)
void	cancel()
void	dequeue()
boolean	equals(Object object)
ActivationGroupNode	getActivationGroupNode()
ActivationNode	getActivationNode()
long	getActivationNumber() Each PropgationContext is assigned an id from a counter for the WorkingMemory action it represents.
org.kie.internal.event.rule.ActivationUnMatchListener	getActivationUnMatchListener()
InternalAgendaGroup	getAgendaGroup()
LinkedList<LogicalDependency>	getBlocked()
LinkedList<LinkedListEntry<LogicalDependency>>	getBlockers()
Consequence	getConsequence()
List<String>	getDeclarationIds()
Object	getDeclarationValue(String variableName)
InternalFactHandle	getFactHandle()
List<FactHandle>	getFactHandles()
LinkedList<LogicalDependency>	getLogicalDependencies()
List<Object>	getObjects()
PropagationContext	getPropagationContext() Retrieve the PropagationContext for the Activation
int	getQueueIndex()
Rule	getRule()
RuleAgendaItem	getRuleAgendaItem()
int	getSalience()
GroupElement	getSubRule() Retrieve the subrule that was activated.
TerminalNode	getTerminalNode()
LeftTuple	getTuple() Retrieve the Tuple that was activated.
int	hashCode()
boolean	isCanceled()
boolean	isMatched()
boolean	isQueued()
boolean	isRuleAgendaItem()
void	remove() Cancel the Activation by removing it from the Agenda.
void	removeAllBlockersAndBlocked(InternalAgenda agenda)
void	removeBlocked(LogicalDependency dep)
void	setActivationGroupNode(ActivationGroupNode activationNode)
void	setActivationNode(ActivationNode activationNode)
void	setActivationUnMatchListener(org.kie.internal.event.rule.ActivationUnMatchListener activationUnMatchListener)
void	setBlocked(LinkedList<LogicalDependency> justified)
void	setFactHandle(InternalFactHandle factHandle)
void	setLogicalDependencies(LinkedList<LogicalDependency> justified)
void	setMatched(boolean matched)
void	setPropagationContext(PropagationContext context)
void	setQueued(boolean queued)
void	setQueueIndex(int index)
void	setSalience(int salience)
String	toExternalForm()
String	toString()

Methods inherited from interface org.drools.core.spi.Activation

isActive, setActive

Method Detail

getPropagationContext

PropagationContext getPropagationContext()

Description copied from interface: Activation

Retrieve the PropagationContext for the Activation

Specified by:

getPropagationContext in interface Activation

Returns:

The propagation context

setPropagationContext

void setPropagationContext(PropagationContext context)

getRule

Rule getRule()

Specified by:

getRule in interface Activation

Specified by:

getRule in interface org.kie.api.runtime.rule.Match

Returns:

The rule that was activated.

getConsequence

Consequence getConsequence()

Specified by:

getConsequence in interface Activation

getTuple

LeftTuple getTuple()

Description copied from interface: Activation

Retrieve the Tuple that was activated.

Specified by:

getTuple in interface Activation

Returns:

The tuple.

getSalience

int getSalience()

Specified by:

getSalience in interface Activation

setSalience

void setSalience(int salience)

getFactHandle

InternalFactHandle getFactHandle()

Specified by:

getFactHandle in interface Activation

setFactHandle

void setFactHandle(InternalFactHandle factHandle)

getRuleAgendaItem

RuleAgendaItem getRuleAgendaItem()

getActivationNumber

long getActivationNumber()

Description copied from interface: Activation

Each PropgationContext is assigned an id from a counter for the WorkingMemory action it represents. All Activations return this id as the ActivationNumber, thus all Activations created from the same PropgationContext will return the same long for this method.

Specified by:

getActivationNumber in interface Activation

Returns:

The activation number

addBlocked

void addBlocked(LogicalDependency dep)

Specified by:

addBlocked in interface Activation

removeAllBlockersAndBlocked

void removeAllBlockersAndBlocked(InternalAgenda agenda)

removeBlocked

void removeBlocked(LogicalDependency dep)

getBlocked

LinkedList<LogicalDependency> getBlocked()

Specified by:

getBlocked in interface Activation

setBlocked

void setBlocked(LinkedList<LogicalDependency> justified)

Specified by:

setBlocked in interface Activation

getBlockers

LinkedList<LinkedListEntry<LogicalDependency>> getBlockers()

Specified by:

getBlockers in interface Activation

addLogicalDependency

void addLogicalDependency(LogicalDependency node)

Specified by:

addLogicalDependency in interface Activation

getLogicalDependencies

LinkedList<LogicalDependency> getLogicalDependencies()

Specified by:

getLogicalDependencies in interface Activation

setLogicalDependencies

void setLogicalDependencies(LinkedList<LogicalDependency> justified)

Specified by:

setLogicalDependencies in interface Activation

isQueued

boolean isQueued()

Specified by:

isQueued in interface Activation

setQueued

void setQueued(boolean queued)

Specified by:

setQueued in interface Activation

toString

String toString()

Overrides:

toString in class Object

equals

boolean equals(Object object)

Overrides:

equals in class Object

hashCode

int hashCode()

Overrides:

hashCode in class Object

setQueueIndex

void setQueueIndex(int index)

Specified by:

setQueueIndex in interface Activation

dequeue

void dequeue()

Specified by:

dequeue in interface Activation

getQueueIndex

int getQueueIndex()

Specified by:

getQueueIndex in interface Activation

remove

void remove()

Description copied from interface: Activation

Cancel the Activation by removing it from the Agenda.

Specified by:

remove in interface Activation

getActivationGroupNode

ActivationGroupNode getActivationGroupNode()

Specified by:

getActivationGroupNode in interface Activation

setActivationGroupNode

void setActivationGroupNode(ActivationGroupNode activationNode)

Specified by:

setActivationGroupNode in interface Activation

getAgendaGroup

InternalAgendaGroup getAgendaGroup()

Specified by:

getAgendaGroup in interface Activation

getActivationNode

ActivationNode getActivationNode()

Specified by:

getActivationNode in interface Activation

setActivationNode

void setActivationNode(ActivationNode activationNode)

Specified by:

setActivationNode in interface Activation

getSubRule

GroupElement getSubRule()

Description copied from interface: Activation

Retrieve the subrule that was activated.

Specified by:

getSubRule in interface Activation

Returns:

getTerminalNode

TerminalNode getTerminalNode()

getActivationUnMatchListener

org.kie.internal.event.rule.ActivationUnMatchListener getActivationUnMatchListener()

setActivationUnMatchListener

void setActivationUnMatchListener(org.kie.internal.event.rule.ActivationUnMatchListener activationUnMatchListener)

getFactHandles

List<FactHandle> getFactHandles()

Specified by:

getFactHandles in interface org.kie.api.runtime.rule.Match

toExternalForm

String toExternalForm()

getObjects

List<Object> getObjects()

Specified by:

getObjects in interface org.kie.api.runtime.rule.Match

getDeclarationValue

Object getDeclarationValue(String variableName)

Specified by:

getDeclarationValue in interface org.kie.api.runtime.rule.Match

getDeclarationIds

List<String> getDeclarationIds()

Specified by:

getDeclarationIds in interface org.kie.api.runtime.rule.Match

isCanceled

boolean isCanceled()

cancel

void cancel()

isMatched

boolean isMatched()

Specified by:

isMatched in interface Activation

setMatched

void setMatched(boolean matched)

Specified by:

setMatched in interface Activation

isRuleAgendaItem

boolean isRuleAgendaItem()

Specified by:

isRuleAgendaItem in interface Activation