Skip navigation links

com.ibm.rules.engine.ruledef.runtime
Interface Agenda

public interface Agenda

Agenda provides information about the agenda during rule engine execution. The agenda lists and orders the rule instances that are eligible to be executed. You use an AgendaController instance to filter and sort the rule instances in the agenda.

The default controller:

• Does not filter any rules.
• Uses the default sort order for the engine mode.

The order in which the agenda is sorted takes the following into account:

• The rule priority.
• The time the rule tuple was added.
• Other rule characteristics.

Method Summary

AgendaController	getAgendaController() Returns the AgendaController.
RuleInstance	getFirstInstance() Returns the first RuleInstance in this Agenda.
int	getInstanceCount() Returns the number of RuleInstance objects currently in this Agenda.
boolean	isEmpty() Tests if the RuleInstance list in this Agenda is empty.
Iterator<RuleInstance>	iterateInstances() Returns an object that you use to iterate through the rule instances in this Agenda.

Method Detail

iterateInstances

Iterator<RuleInstance> iterateInstances()

Returns an object that you use to iterate through the rule instances in this Agenda.

Returns:

An rule instance list iterator.

getFirstInstance

RuleInstance getFirstInstance()

Returns the first RuleInstance in this Agenda.

Returns:

The rule that will be executed next.

getInstanceCount

int getInstanceCount()

Returns the number of RuleInstance objects currently in this Agenda.

Returns:

The number of RuleInstance objects currently in this Agenda.

getAgendaController

AgendaController getAgendaController()

Returns the AgendaController.

Returns:

The current AgendaController.

isEmpty

boolean isEmpty()

Tests if the RuleInstance list in this Agenda is empty.

Returns:

If this Agenda is empty, true is returned.