AgendaItem (Drools :: Core 6.3.0.Final API)

All Superinterfaces:

Activation<T>, org.kie.api.runtime.rule.Match, Serializable

All Known Implementing Classes:

AgendaItemImpl, RuleAgendaItem, RuleTerminalNodeLeftTuple, ScheduledAgendaItem
```
public interface AgendaItem<T extends ModedAssertion<T>>
extends Activation<T>
```

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addBlocked(LogicalDependency<SimpleMode> dep)`
`void`	`addLogicalDependency(LogicalDependency<T> 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<SimpleMode>>`	`getBlocked()`
`LinkedList<SimpleMode>`	`getBlockers()`
`Consequence`	`getConsequence()`
`List<String>`	`getDeclarationIds()`
`Object`	`getDeclarationValue(String variableName)`
`InternalFactHandle`	`getFactHandle()`
`List<org.kie.api.runtime.rule.FactHandle>`	`getFactHandles()`
`LinkedList<LogicalDependency<T>>`	`getLogicalDependencies()`
`List<Object>`	`getObjects()`
`PropagationContext`	`getPropagationContext()` Retrieve the `PropagationContext` for the `Activation`
`int`	`getQueueIndex()`
`RuleImpl`	`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<SimpleMode> dep)`
`void`	`setActivationGroupNode(ActivationGroupNode activationNode)`
`void`	`setActivationNode(ActivationNode activationNode)`
`void`	`setActivationUnMatchListener(org.kie.internal.event.rule.ActivationUnMatchListener activationUnMatchListener)`
`void`	`setBlocked(LinkedList<LogicalDependency<SimpleMode>> justified)`
`void`	`setFactHandle(InternalFactHandle factHandle)`
`void`	`setLogicalDependencies(LinkedList<LogicalDependency<T>> 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<T extends ModedAssertion<T>>
    
    Returns:
    The propagation context
  - setPropagationContext
```
void setPropagationContext(PropagationContext context)
```
  - getRule
```
RuleImpl getRule()
```
    Specified by:
    
    getRule in interface Activation<T extends ModedAssertion<T>>
    
    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<T extends ModedAssertion<T>>
  - getTuple
```
LeftTuple getTuple()
```
    Description copied from interface: Activation
    
    Retrieve the Tuple that was activated.
    
    Specified by:
    
    getTuple in interface Activation<T extends ModedAssertion<T>>
    
    Returns:
    The tuple.
  - getSalience
```
int getSalience()
```
    Specified by:
    
    getSalience in interface Activation<T extends ModedAssertion<T>>
  - setSalience
```
void setSalience(int salience)
```
  - getFactHandle
```
InternalFactHandle getFactHandle()
```
    Specified by:
    
    getFactHandle in interface Activation<T extends ModedAssertion<T>>
  - 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<T extends ModedAssertion<T>>
    
    Returns:
    The activation number
  - addBlocked
```
void addBlocked(LogicalDependency<SimpleMode> dep)
```
    Specified by:
    
    addBlocked in interface Activation<T extends ModedAssertion<T>>
  - removeAllBlockersAndBlocked
```
void removeAllBlockersAndBlocked(InternalAgenda agenda)
```
  - removeBlocked
```
void removeBlocked(LogicalDependency<SimpleMode> dep)
```
  - getBlocked
```
LinkedList<LogicalDependency<SimpleMode>> getBlocked()
```
    Specified by:
    
    getBlocked in interface Activation<T extends ModedAssertion<T>>
  - setBlocked
```
void setBlocked(LinkedList<LogicalDependency<SimpleMode>> justified)
```
    Specified by:
    
    setBlocked in interface Activation<T extends ModedAssertion<T>>
  - getBlockers
```
LinkedList<SimpleMode> getBlockers()
```
    Specified by:
    
    getBlockers in interface Activation<T extends ModedAssertion<T>>
  - addLogicalDependency
```
void addLogicalDependency(LogicalDependency<T> node)
```
    Specified by:
    
    addLogicalDependency in interface Activation<T extends ModedAssertion<T>>
  - getLogicalDependencies
```
LinkedList<LogicalDependency<T>> getLogicalDependencies()
```
    Specified by:
    
    getLogicalDependencies in interface Activation<T extends ModedAssertion<T>>
  - setLogicalDependencies
```
void setLogicalDependencies(LinkedList<LogicalDependency<T>> justified)
```
    Specified by:
    
    setLogicalDependencies in interface Activation<T extends ModedAssertion<T>>
  - isQueued
```
boolean isQueued()
```
    Specified by:
    
    isQueued in interface Activation<T extends ModedAssertion<T>>
  - setQueued
```
void setQueued(boolean queued)
```
    Specified by:
    
    setQueued in interface Activation<T extends ModedAssertion<T>>
  - 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<T extends ModedAssertion<T>>
  - dequeue
```
void dequeue()
```
    Specified by:
    
    dequeue in interface Activation<T extends ModedAssertion<T>>
  - getQueueIndex
```
int getQueueIndex()
```
    Specified by:
    
    getQueueIndex in interface Activation<T extends ModedAssertion<T>>
  - remove
```
void remove()
```
    Description copied from interface: Activation
    
    Cancel the Activation by removing it from the Agenda.
    
    Specified by:
    
    remove in interface Activation<T extends ModedAssertion<T>>
  - getActivationGroupNode
```
ActivationGroupNode getActivationGroupNode()
```
    Specified by:
    
    getActivationGroupNode in interface Activation<T extends ModedAssertion<T>>
  - setActivationGroupNode
```
void setActivationGroupNode(ActivationGroupNode activationNode)
```
    Specified by:
    
    setActivationGroupNode in interface Activation<T extends ModedAssertion<T>>
  - getAgendaGroup
```
InternalAgendaGroup getAgendaGroup()
```
    Specified by:
    
    getAgendaGroup in interface Activation<T extends ModedAssertion<T>>
  - getActivationNode
```
ActivationNode getActivationNode()
```
    Specified by:
    
    getActivationNode in interface Activation<T extends ModedAssertion<T>>
  - setActivationNode
```
void setActivationNode(ActivationNode activationNode)
```
    Specified by:
    
    setActivationNode in interface Activation<T extends ModedAssertion<T>>
  - getSubRule
```
GroupElement getSubRule()
```
    Description copied from interface: Activation
    
    Retrieve the subrule that was activated.
    
    Specified by:
    
    getSubRule in interface Activation<T extends ModedAssertion<T>>
    
    Returns:
  - getTerminalNode
```
TerminalNode getTerminalNode()
```
  - getActivationUnMatchListener
```
org.kie.internal.event.rule.ActivationUnMatchListener getActivationUnMatchListener()
```
  - setActivationUnMatchListener
```
void setActivationUnMatchListener(org.kie.internal.event.rule.ActivationUnMatchListener activationUnMatchListener)
```
  - getFactHandles
```
List<org.kie.api.runtime.rule.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<T extends ModedAssertion<T>>
  - setMatched
```
void setMatched(boolean matched)
```
    Specified by:
    
    setMatched in interface Activation<T extends ModedAssertion<T>>
  - isRuleAgendaItem
```
boolean isRuleAgendaItem()
```
    Specified by:
    
    isRuleAgendaItem in interface Activation<T extends ModedAssertion<T>>

Interface AgendaItem<T extends ModedAssertion<T>>

Method Summary

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

Method Detail

getPropagationContext

setPropagationContext

getRule

getConsequence

getTuple

getSalience

setSalience

getFactHandle

setFactHandle

getRuleAgendaItem

getActivationNumber

addBlocked

removeAllBlockersAndBlocked

removeBlocked

getBlocked

setBlocked

getBlockers

addLogicalDependency

getLogicalDependencies

setLogicalDependencies

isQueued

setQueued

toString

equals

hashCode

setQueueIndex

dequeue

getQueueIndex

remove

getActivationGroupNode

setActivationGroupNode

getAgendaGroup

getActivationNode

setActivationNode

getSubRule

getTerminalNode

getActivationUnMatchListener

setActivationUnMatchListener

getFactHandles

toExternalForm

getObjects

getDeclarationValue

getDeclarationIds

isCanceled

cancel

isMatched

setMatched

isRuleAgendaItem