Activation (Drools :: Core 6.3.0.CR2 API)

All Superinterfaces:

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

All Known Subinterfaces:

AgendaItem<T>

All Known Implementing Classes:

AgendaItemImpl, RuleAgendaItem, RuleTerminalNodeLeftTuple, ScheduledAgendaItem, VisitedAgendaGroup
```
public interface Activation<T extends ModedAssertion<T>>
extends Serializable, org.kie.api.runtime.rule.Match
```
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.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addBlocked(LogicalDependency<SimpleMode> node)`
`void`	`addLogicalDependency(LogicalDependency<T> node)`
`void`	`dequeue()`
`ActivationGroupNode`	`getActivationGroupNode()`
`ActivationNode`	`getActivationNode()`
`long`	`getActivationNumber()` Each PropgationContext is assigned an id from a counter for the WorkingMemory action it represents.
`InternalAgendaGroup`	`getAgendaGroup()`
`LinkedList<LogicalDependency<SimpleMode>>`	`getBlocked()`
`LinkedList<SimpleMode>`	`getBlockers()`
`Consequence`	`getConsequence()`
`InternalFactHandle`	`getFactHandle()`
`LinkedList<LogicalDependency<T>>`	`getLogicalDependencies()`
`PropagationContext`	`getPropagationContext()` Retrieve the `PropagationContext` for the `Activation`
`int`	`getQueueIndex()`
`RuleImpl`	`getRule()`
`int`	`getSalience()`
`GroupElement`	`getSubRule()` Retrieve the subrule that was activated.
`LeftTuple`	`getTuple()` Retrieve the `Tuple` that was activated.
`boolean`	`isActive()`
`boolean`	`isMatched()`
`boolean`	`isQueued()`
`boolean`	`isRuleAgendaItem()`
`void`	`remove()` Cancel the `Activation` by removing it from the `Agenda`.
`void`	`setActivationGroupNode(ActivationGroupNode activationGroupNode)`
`void`	`setActivationNode(ActivationNode ruleFlowGroupNode)`
`void`	`setActive(boolean active)`
`void`	`setBlocked(LinkedList<LogicalDependency<SimpleMode>> justified)`
`void`	`setLogicalDependencies(LinkedList<LogicalDependency<T>> justified)`
`void`	`setMatched(boolean matched)`
`void`	`setQueued(boolean activated)`
`void`	`setQueueIndex(int index)`

Methods inherited from interface org.kie.api.runtime.rule.Match
getDeclarationIds, getDeclarationValue, getFactHandles, getObjects

Method Detail

getRule
```
RuleImpl getRule()
```
Specified by:

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

Returns:
The rule that was activated.

getConsequence
```
Consequence getConsequence()
```

getSalience
```
int getSalience()
```

getSubRule
```
GroupElement getSubRule()
```
Retrieve the subrule that was activated.

Returns:

getActivationNumber
```
long getActivationNumber()
```
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.

Returns:
The activation number

getTuple
```
LeftTuple getTuple()
```
Retrieve the Tuple that was activated.

Returns:
The tuple.

getPropagationContext
```
PropagationContext getPropagationContext()
```
Retrieve the PropagationContext for the Activation

Returns:
The propagation context

remove
```
void remove()
```
Cancel the Activation by removing it from the Agenda.

addBlocked

void addBlocked(LogicalDependency<SimpleMode> node)

getBlocked

LinkedList<LogicalDependency<SimpleMode>> getBlocked()

setBlocked

void setBlocked(LinkedList<LogicalDependency<SimpleMode>> justified)

getBlockers
```
LinkedList<SimpleMode> getBlockers()
```

addLogicalDependency

void addLogicalDependency(LogicalDependency<T> node)

getLogicalDependencies

LinkedList<LogicalDependency<T>> getLogicalDependencies()

setLogicalDependencies

void setLogicalDependencies(LinkedList<LogicalDependency<T>> justified)

setQueued
```
void setQueued(boolean activated)
```

isQueued
```
boolean isQueued()
```

getAgendaGroup
```
InternalAgendaGroup getAgendaGroup()
```

getActivationGroupNode

ActivationGroupNode getActivationGroupNode()

setActivationGroupNode

void setActivationGroupNode(ActivationGroupNode activationGroupNode)

getActivationNode
```
ActivationNode getActivationNode()
```

setActivationNode

void setActivationNode(ActivationNode ruleFlowGroupNode)

getFactHandle
```
InternalFactHandle getFactHandle()
```

isMatched
```
boolean isMatched()
```

setMatched
```
void setMatched(boolean matched)
```

isActive
```
boolean isActive()
```

setActive
```
void setActive(boolean active)
```

isRuleAgendaItem
```
boolean isRuleAgendaItem()
```

setQueueIndex
```
void setQueueIndex(int index)
```

getQueueIndex
```
int getQueueIndex()
```

dequeue
```
void dequeue()
```

Interface Activation<T extends ModedAssertion<T>>

Method Summary

Methods inherited from interface org.kie.api.runtime.rule.Match

Method Detail

getRule

getConsequence

getSalience

getSubRule

getActivationNumber

getTuple

getPropagationContext

remove

addBlocked

getBlocked

setBlocked

getBlockers

addLogicalDependency

getLogicalDependencies

setLogicalDependencies

setQueued

isQueued

getAgendaGroup

getActivationGroupNode

setActivationGroupNode

getActivationNode

setActivationNode

getFactHandle

isMatched

setMatched

isActive

setActive

isRuleAgendaItem

setQueueIndex

getQueueIndex

dequeue