ScheduledAgendaItem (Drools :: Core 6.4.0.Beta2 API)

java.lang.Object
- org.drools.core.common.ScheduledAgendaItem<T>

All Implemented Interfaces:

Serializable, AgendaItem<T>, Activation<T>, Entry<ScheduledAgendaItem<T>>, LinkedListNode<ScheduledAgendaItem<T>>, org.kie.api.runtime.rule.Match
```
public class ScheduledAgendaItem<T extends ModedAssertion<T>>
extends Object
implements AgendaItem<T>, LinkedListNode<ScheduledAgendaItem<T>>
```
See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description

ScheduledAgendaItem(AgendaItem agendaItem, InternalAgenda agenda)

Constructors
Constructor and Description
`ScheduledAgendaItem(AgendaItem agendaItem, InternalAgenda agenda)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addBlocked(LogicalDependency dep)`
`void`	`addLogicalDependency(LogicalDependency<T> node)`
`void`	`cancel()`
`void`	`dequeue()`
`InternalFactHandle`	`getActivationFactHandle()`
`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)`
`List<org.kie.api.runtime.rule.FactHandle>`	`getFactHandles()`
`JobHandle`	`getJobHandle()`
`LinkedList<LogicalDependency<T>>`	`getLogicalDependencies()`
`ScheduledAgendaItem`	`getNext()`
`List<Object>`	`getObjects()`
`ScheduledAgendaItem`	`getPrevious()` Returns the previous node
`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()`
`Tuple`	`getTuple()` Retrieve the `Tuple` that was activated.
`boolean`	`isActive()`
`boolean`	`isCanceled()`
`boolean`	`isEnqueued()`
`boolean`	`isMatched()`
`boolean`	`isQueued()`
`boolean`	`isRuleAgendaItem()`
`void`	`nullPrevNext()`
`void`	`remove()` Cancel the `Activation` by removing it from the `Agenda`.
`void`	`removeAllBlockersAndBlocked(InternalAgenda agenda)`
`void`	`removeBlocked(LogicalDependency dep)`
`void`	`setActivationFactHandle(InternalFactHandle factHandle)`
`void`	`setActivationGroupNode(ActivationGroupNode activationNode)`
`void`	`setActivationNode(ActivationNode activationNode)`
`void`	`setActivationUnMatchListener(org.kie.internal.event.rule.ActivationUnMatchListener activationUnMatchListener)`
`void`	`setActive(boolean active)`
`void`	`setBlocked(LinkedList<LogicalDependency<SimpleMode>> justified)`
`void`	`setEnqueued(boolean enqueued)`
`void`	`setJobHandle(JobHandle jobHandle)`
`void`	`setLogicalDependencies(LinkedList<LogicalDependency<T>> justified)`
`void`	`setMatched(boolean matched)`
`void`	`setNext(ScheduledAgendaItem next)`
`void`	`setPrevious(ScheduledAgendaItem previous)` Sets the previous node
`void`	`setPropagationContext(PropagationContext context)`
`void`	`setQueued(boolean queued)`
`void`	`setQueueIndex(int index)`
`void`	`setSalience(int salience)`
`String`	`toExternalForm()`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ScheduledAgendaItem
```
public ScheduledAgendaItem(AgendaItem agendaItem,
                   InternalAgenda agenda)
```
- Method Detail
  - getPropagationContext
```
public 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
```
public void setPropagationContext(PropagationContext context)
```
    Specified by:
    
    setPropagationContext in interface AgendaItem<T extends ModedAssertion<T>>
  - isMatched
```
public boolean isMatched()
```
    Specified by:
    
    isMatched in interface Activation<T extends ModedAssertion<T>>
  - setMatched
```
public void setMatched(boolean matched)
```
    Specified by:
    
    setMatched in interface Activation<T extends ModedAssertion<T>>
  - isActive
```
public boolean isActive()
```
    Specified by:
    
    isActive in interface Activation<T extends ModedAssertion<T>>
  - setActive
```
public void setActive(boolean active)
```
    Specified by:
    
    setActive in interface Activation<T extends ModedAssertion<T>>
  - getTerminalNode
```
public TerminalNode getTerminalNode()
```
    Specified by:
    
    getTerminalNode in interface AgendaItem<T extends ModedAssertion<T>>
  - getSalience
```
public int getSalience()
```
    Specified by:
    
    getSalience in interface Activation<T extends ModedAssertion<T>>
  - setSalience
```
public void setSalience(int salience)
```
    Specified by:
    
    setSalience in interface AgendaItem<T extends ModedAssertion<T>>
  - toExternalForm
```
public String toExternalForm()
```
    Specified by:
    
    toExternalForm in interface AgendaItem<T extends ModedAssertion<T>>
  - getBlocked
```
public LinkedList<LogicalDependency<SimpleMode>> getBlocked()
```
    Specified by:
    
    getBlocked in interface Activation<T extends ModedAssertion<T>>
  - setBlocked
```
public void setBlocked(LinkedList<LogicalDependency<SimpleMode>> justified)
```
    Specified by:
    
    setBlocked in interface Activation<T extends ModedAssertion<T>>
  - getActivationFactHandle
```
public InternalFactHandle getActivationFactHandle()
```
    Specified by:
    
    getActivationFactHandle in interface Activation<T extends ModedAssertion<T>>
  - setActivationFactHandle
```
public void setActivationFactHandle(InternalFactHandle factHandle)
```
    Specified by:
    
    setActivationFactHandle in interface AgendaItem<T extends ModedAssertion<T>>
  - getActivationGroupNode
```
public ActivationGroupNode getActivationGroupNode()
```
    Specified by:
    
    getActivationGroupNode in interface Activation<T extends ModedAssertion<T>>
  - setActivationGroupNode
```
public void setActivationGroupNode(ActivationGroupNode activationNode)
```
    Specified by:
    
    setActivationGroupNode in interface Activation<T extends ModedAssertion<T>>
  - getConsequence
```
public Consequence getConsequence()
```
    Specified by:
    
    getConsequence in interface Activation<T extends ModedAssertion<T>>
  - getActivationUnMatchListener
```
public org.kie.internal.event.rule.ActivationUnMatchListener getActivationUnMatchListener()
```
    Specified by:
    
    getActivationUnMatchListener in interface AgendaItem<T extends ModedAssertion<T>>
  - setActivationUnMatchListener
```
public void setActivationUnMatchListener(org.kie.internal.event.rule.ActivationUnMatchListener activationUnMatchListener)
```
    Specified by:
    
    setActivationUnMatchListener in interface AgendaItem<T extends ModedAssertion<T>>
  - getRule
```
public 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.
  - getAgendaGroup
```
public InternalAgendaGroup getAgendaGroup()
```
    Specified by:
    
    getAgendaGroup in interface Activation<T extends ModedAssertion<T>>
  - getActivationNumber
```
public 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
  - removeBlocked
```
public void removeBlocked(LogicalDependency dep)
```
    Specified by:
    
    removeBlocked in interface AgendaItem<T extends ModedAssertion<T>>
  - addBlocked
```
public void addBlocked(LogicalDependency dep)
```
    Specified by:
    
    addBlocked in interface Activation<T extends ModedAssertion<T>>
  - dequeue
```
public void dequeue()
```
    Specified by:
    
    dequeue in interface Activation<T extends ModedAssertion<T>>
  - getQueueIndex
```
public int getQueueIndex()
```
    Specified by:
    
    getQueueIndex in interface Activation<T extends ModedAssertion<T>>
  - setQueueIndex
```
public void setQueueIndex(int index)
```
    Specified by:
    
    setQueueIndex in interface Activation<T extends ModedAssertion<T>>
  - isQueued
```
public boolean isQueued()
```
    Specified by:
    
    isQueued in interface Activation<T extends ModedAssertion<T>>
  - setQueued
```
public void setQueued(boolean queued)
```
    Specified by:
    
    setQueued in interface Activation<T extends ModedAssertion<T>>
  - addLogicalDependency
```
public void addLogicalDependency(LogicalDependency<T> node)
```
    Specified by:
    
    addLogicalDependency in interface Activation<T extends ModedAssertion<T>>
  - getBlockers
```
public LinkedList<SimpleMode> getBlockers()
```
    Specified by:
    
    getBlockers in interface Activation<T extends ModedAssertion<T>>
  - getDeclarationValue
```
public Object getDeclarationValue(String variableName)
```
    Specified by:
    
    getDeclarationValue in interface org.kie.api.runtime.rule.Match
  - getRuleAgendaItem
```
public RuleAgendaItem getRuleAgendaItem()
```
    Specified by:
    
    getRuleAgendaItem in interface AgendaItem<T extends ModedAssertion<T>>
  - getTuple
```
public Tuple 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.
  - getDeclarationIds
```
public List<String> getDeclarationIds()
```
    Specified by:
    
    getDeclarationIds in interface org.kie.api.runtime.rule.Match
  - cancel
```
public void cancel()
```
    Specified by:
    
    cancel in interface AgendaItem<T extends ModedAssertion<T>>
  - getActivationNode
```
public ActivationNode getActivationNode()
```
    Specified by:
    
    getActivationNode in interface Activation<T extends ModedAssertion<T>>
  - setActivationNode
```
public void setActivationNode(ActivationNode activationNode)
```
    Specified by:
    
    setActivationNode in interface Activation<T extends ModedAssertion<T>>
  - getSubRule
```
public GroupElement getSubRule()
```
    Description copied from interface: Activation
    
    Retrieve the subrule that was activated.
    
    Specified by:
    
    getSubRule in interface Activation<T extends ModedAssertion<T>>
    
    Returns:
  - removeAllBlockersAndBlocked
```
public void removeAllBlockersAndBlocked(InternalAgenda agenda)
```
    Specified by:
    
    removeAllBlockersAndBlocked in interface AgendaItem<T extends ModedAssertion<T>>
  - isCanceled
```
public boolean isCanceled()
```
    Specified by:
    
    isCanceled in interface AgendaItem<T extends ModedAssertion<T>>
  - getObjects
```
public List<Object> getObjects()
```
    Specified by:
    
    getObjects in interface org.kie.api.runtime.rule.Match
  - isRuleAgendaItem
```
public boolean isRuleAgendaItem()
```
    Specified by:
    
    isRuleAgendaItem in interface Activation<T extends ModedAssertion<T>>
  - getLogicalDependencies
```
public LinkedList<LogicalDependency<T>> getLogicalDependencies()
```
    Specified by:
    
    getLogicalDependencies in interface Activation<T extends ModedAssertion<T>>
  - setLogicalDependencies
```
public void setLogicalDependencies(LinkedList<LogicalDependency<T>> justified)
```
    Specified by:
    
    setLogicalDependencies in interface Activation<T extends ModedAssertion<T>>
  - getFactHandles
```
public List<org.kie.api.runtime.rule.FactHandle> getFactHandles()
```
    Specified by:
    
    getFactHandles in interface AgendaItem<T extends ModedAssertion<T>>
    
    Specified by:
    
    getFactHandles in interface org.kie.api.runtime.rule.Match
  - getNext
```
public ScheduledAgendaItem getNext()
```
    Specified by:
    
    getNext in interface Entry<ScheduledAgendaItem<T extends ModedAssertion<T>>>
  - setNext
```
public void setNext(ScheduledAgendaItem next)
```
    Specified by:
    
    setNext in interface Entry<ScheduledAgendaItem<T extends ModedAssertion<T>>>
  - getPrevious
```
public ScheduledAgendaItem getPrevious()
```
    Description copied from interface: LinkedListNode
    
    Returns the previous node
    
    Specified by:
    
    getPrevious in interface LinkedListNode<ScheduledAgendaItem<T extends ModedAssertion<T>>>
    
    Returns:
    The previous LinkedListNode
  - setPrevious
```
public void setPrevious(ScheduledAgendaItem previous)
```
    Description copied from interface: LinkedListNode
    
    Sets the previous node
    
    Specified by:
    
    setPrevious in interface LinkedListNode<ScheduledAgendaItem<T extends ModedAssertion<T>>>
    
    Parameters:
    previous - The previous LinkedListNode
  - nullPrevNext
```
public void nullPrevNext()
```
    Specified by:
    
    nullPrevNext in interface LinkedListNode<ScheduledAgendaItem<T extends ModedAssertion<T>>>
  - remove
```
public 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>>
  - getJobHandle
```
public JobHandle getJobHandle()
```
  - setJobHandle
```
public void setJobHandle(JobHandle jobHandle)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - isEnqueued
```
public boolean isEnqueued()
```
  - setEnqueued
```
public void setEnqueued(boolean enqueued)
```

Class ScheduledAgendaItem<T extends ModedAssertion<T>>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ScheduledAgendaItem

Method Detail

getPropagationContext

setPropagationContext

isMatched

setMatched

isActive

setActive

getTerminalNode

getSalience

setSalience

toExternalForm

getBlocked

setBlocked

getActivationFactHandle

setActivationFactHandle

getActivationGroupNode

setActivationGroupNode

getConsequence

getActivationUnMatchListener

setActivationUnMatchListener

getRule

getAgendaGroup

getActivationNumber

removeBlocked

addBlocked

dequeue

getQueueIndex

setQueueIndex

isQueued

setQueued

addLogicalDependency

getBlockers

getDeclarationValue

getRuleAgendaItem

getTuple

getDeclarationIds

cancel

getActivationNode

setActivationNode

getSubRule

removeAllBlockersAndBlocked

isCanceled

getObjects

isRuleAgendaItem

getLogicalDependencies

setLogicalDependencies

getFactHandles

getNext

setNext

getPrevious

setPrevious

nullPrevNext

remove

getJobHandle

setJobHandle

toString

isEnqueued

setEnqueued