Rule Execution Server API

ilog.rules.engine
Class IlrRuleInstance

java.lang.Object
  extended by ilog.rules.engine.IlrRuleInstance
All Implemented Interfaces:
Serializable

public final class IlrRuleInstance
extends Object
implements Serializable

IlrRuleInstance objects are rule instances currently fireable in the agenda of the context.

See Also:
Serialized Form

Method Summary
 void fire()
           Fires the rule instance which executes the action part of the rule.
 Object[] getObjects()
           Gets the objects matched by this rule instance.
 int getPriority()
           Gets the priority value of this instance.
 int getRecency()
           
 IlrRule getRule()
           Gets the rule of this instance.
 String getRuleName()
           Gets the rule name of this instance.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getRecency

public int getRecency()

getRule

public IlrRule getRule()

Gets the rule of this instance.

Returns:
the rule of this instance.

getRuleName

public String getRuleName()

Gets the rule name of this instance.

Returns:
the rule name of this instance.

getPriority

public int getPriority()

Gets the priority value of this instance.

Returns:
the priority value.

getObjects

public Object[] getObjects()

Gets the objects matched by this rule instance. The objects are ordered according to the appearance order of the rule conditions. A null element represents a condition which does not bind an object, such as not and exists.

Returns:
an array of objects. The length of the array is always greater than zero. Its elements can be null.

fire

public void fire()

Fires the rule instance which executes the action part of the rule.


Rule Execution Server API

© Copyright IBM Corp. 1987, 2013