org.drools
Interface Agenda

All Superinterfaces:
org.drools.runtime.rule.Agenda
All Known Subinterfaces:
InternalAgenda
All Known Implementing Classes:
DefaultAgenda

public interface Agenda
extends org.drools.runtime.rule.Agenda

Agenda interface for the WorkingMemory


Method Summary
 void activateRuleFlowGroup(String name)
          Activates the RuleFlowGroup with the given name.
 void activateRuleFlowGroup(String name, long processInstanceId, String nodeInstanceId)
          Activates the RuleFlowGroup with the given name.
 int agendaSize()
          Iterates all the modules in the focus stack returning the total number of Activations
 void clearAndCancel()
          Clears all Activations from the Agenda
 void clearAndCancelActivationGroup(ActivationGroup activationGroup)
          Clears all Activations from an Activation Group.
 void clearAndCancelActivationGroup(String name)
          Clears all Activations from an Activation-Group.
 void clearAndCancelAgendaGroup(AgendaGroup agendaGroup)
          Clears all Activations from an Agenda Group.
 void clearAndCancelAgendaGroup(String name)
          Clears all Activations from an Agenda Group.
 void clearAndCancelAndCancel(RuleFlowGroup ruleFlowGroup)
           
 void clearAndCancelRuleFlowGroup(String name)
           
 void deactivateRuleFlowGroup(String name)
          Deactivates the RuleFlowGroup with the given name.
 int focusStackSize()
          Iterates all the AgendGroups in the focus stack returning the total number of Activations
 ActivationGroup getActivationGroup(String name)
           
 Activation[] getActivations()
           
 AgendaGroup getAgendaGroup(String name)
           
 AgendaGroup[] getAgendaGroups()
           
 String getFocusName()
          Returns the name of the agenda group that currently has the focus
 RuleFlowGroup getRuleFlowGroup(String name)
           
 Activation[] getScheduledActivations()
           
 AgendaGroup[] getStack()
           
 WorkingMemory getWorkingMemory()
          Returns the WorkignMemory for this Agenda
 void setFocus(String name)
          Sets the Agenda's focus to the specified AgendaGroup
 
Methods inherited from interface org.drools.runtime.rule.Agenda
clear
 

Method Detail

getWorkingMemory

WorkingMemory getWorkingMemory()
Returns the WorkignMemory for this Agenda

Returns:
The WorkingMemory

setFocus

void setFocus(String name)
Sets the Agenda's focus to the specified AgendaGroup

Parameters:
agendaGroup -

activateRuleFlowGroup

void activateRuleFlowGroup(String name)
Activates the RuleFlowGroup with the given name. All activations in the given RuleFlowGroup are added to the agenda. As long as the RuleFlowGroup remains active, its activations are automatically added to the agenda.


activateRuleFlowGroup

void activateRuleFlowGroup(String name,
                           long processInstanceId,
                           String nodeInstanceId)
Activates the RuleFlowGroup with the given name. All activations in the given RuleFlowGroup are added to the agenda. As long as the RuleFlowGroup remains active, its activations are automatically added to the agenda. The given processInstanceId and nodeInstanceId define the process context in which this RuleFlowGroup is used.


deactivateRuleFlowGroup

void deactivateRuleFlowGroup(String name)
Deactivates the RuleFlowGroup with the given name. All activations in the given RuleFlowGroup are removed from the agenda. As long as the RuleFlowGroup remains deactive, its activations are not added to the agenda


getAgendaGroups

AgendaGroup[] getAgendaGroups()

getStack

AgendaGroup[] getStack()

focusStackSize

int focusStackSize()
Iterates all the AgendGroups in the focus stack returning the total number of Activations

Returns:
total number of Activations on the focus stack

agendaSize

int agendaSize()
Iterates all the modules in the focus stack returning the total number of Activations

Returns:
total number of activations on the focus stack

getActivations

Activation[] getActivations()

getScheduledActivations

Activation[] getScheduledActivations()

clearAndCancel

void clearAndCancel()
Clears all Activations from the Agenda


clearAndCancelAgendaGroup

void clearAndCancelAgendaGroup(String name)
Clears all Activations from an Agenda Group. Any Activations that are also in an Xor Group are removed the the Xor Group.

Parameters:
agendaGroup -

clearAndCancelAgendaGroup

void clearAndCancelAgendaGroup(AgendaGroup agendaGroup)
Clears all Activations from an Agenda Group. Any Activations that are also in an Xor Group are removed the the Xor Group.

Parameters:
agendaGroup -

clearAndCancelActivationGroup

void clearAndCancelActivationGroup(String name)
Clears all Activations from an Activation-Group. Any Activations that are also in an Agenda Group are removed from the Agenda Group.

Parameters:
activationGroup -

clearAndCancelActivationGroup

void clearAndCancelActivationGroup(ActivationGroup activationGroup)
Clears all Activations from an Activation Group. Any Activations that are also in an Agenda Group are removed from the Agenda Group.

Parameters:
activationGroup -

clearAndCancelRuleFlowGroup

void clearAndCancelRuleFlowGroup(String name)

clearAndCancelAndCancel

void clearAndCancelAndCancel(RuleFlowGroup ruleFlowGroup)

getFocusName

String getFocusName()
Returns the name of the agenda group that currently has the focus

Returns:

getAgendaGroup

AgendaGroup getAgendaGroup(String name)
Specified by:
getAgendaGroup in interface org.drools.runtime.rule.Agenda

getActivationGroup

ActivationGroup getActivationGroup(String name)
Specified by:
getActivationGroup in interface org.drools.runtime.rule.Agenda

getRuleFlowGroup

RuleFlowGroup getRuleFlowGroup(String name)
Specified by:
getRuleFlowGroup in interface org.drools.runtime.rule.Agenda


Copyright © 2001-2013 JBoss Inc.. All Rights Reserved.