Skip navigation links

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

public interface RuleInstance

An RuleInstance object is defined by the association between an RuleAction and the tuple that satisfies the condition part of a Rule. Although a Rule can be composed of several RuleAction parts, a RuleInstance object is linked to one RuleAction only.

See Also:

RuleAction

Method Summary

EngineData	getEngineData() Returns the EngineData linked to this RuleInstance.
int	getPriority() Returns the priority of the Rule object linked to this RuleInstance.
int	getRecency() Returns the recency of the tuple linked to this RuleInstance.
Rule	getRule() Returns the Rule object linked to this rule instance.
RuleAction	getRuleAction() Returns the RuleAction linked this RuleInstance.
String	getRuleName() Returns the name of the Rule object linked to this rule instance.
Object[]	getTuple() Returns the object bindings or the tuple that satisfies the rule conditions.
Map<String,Object>	getVariables() Return the map of variables of the rule instance.

Method Detail

getRule

Rule getRule()

Returns the Rule object linked to this rule instance.

Returns:

The linked Rule.

getRuleName

String getRuleName()

Returns the name of the Rule object linked to this rule instance.

Returns:

The Rule name.

getRuleAction

RuleAction getRuleAction()

Returns the RuleAction linked this RuleInstance.

Returns:

The RuleAction instance linked this RuleInstance.

getTuple

Object[] getTuple()

Returns the object bindings or the tuple that satisfies the rule conditions.

Returns:

The tuple that satisfies the rule conditions.

getEngineData

EngineData getEngineData()

Returns the EngineData linked to this RuleInstance.

Returns:

The EngineData linked to this RuleInstance.

getPriority

int getPriority()

Returns the priority of the Rule object linked to this RuleInstance.

Returns:

The rule priority.

getRecency

int getRecency()

Returns the recency of the tuple linked to this RuleInstance.

Returns:

The recency of the tuple linked to this RuleInstance.

getVariables

Map<String,Object> getVariables()

Return the map of variables of the rule instance.

Returns:

The map of value of the rule instance variables.