com.cordys.bre.engine

Class Action

java.lang.Object

com.cordys.bre.engine.Action

public abstract class Action
extends java.lang.Object

An action in the rule. The rule engine client can register the various implementations of this class for various actions. The action class implementation has to be registered on the rule engine instance as shown below:

 ruleengine.registerActionHandlerClass("nameofaction", ClientAction.Class);
 

Whenever an action of the specified type is encountered during rule evaluation the action handler class will be instantiated and called by rule engine.

Constructor Summary

Constructors

Constructor and Description
Action(RuleSession ruleSession, IRule rule, int actionNode) Creates an action with the given ruleSession, IRule and Action *

Method Summary

Modifier and Type	Method and Description
abstract void	execute() Execute the given rule action based on rules condition.
int	getActionNode() Returns the action node as int Node
IRule	getRule() Returns the rule to which the action belongs to
RuleSession	getRuleSession() Returns the session to which the rule belongs to
void	setActionNode(int actionNode) Sets the action node int
void	setRule(IRule rule) Sets the rule for the action
void	setRuleSession(RuleSession ruleSession) Sets the rule session

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Action

public Action(RuleSession ruleSession,
              IRule rule,
              int actionNode)

Creates an action with the given ruleSession, IRule and Action *

Method Detail

setRuleSession

public void setRuleSession(RuleSession ruleSession)

Sets the rule session

setActionNode

public void setActionNode(int actionNode)

Sets the action node int

setRule

public void setRule(IRule rule)

Sets the rule for the action

getRuleSession

public RuleSession getRuleSession()

Returns the session to which the rule belongs to

getActionNode

public int getActionNode()

Returns the action node as int Node

Returns:

int node

getRule

public IRule getRule()

Returns the rule to which the action belongs to

Returns:

IRule

execute

public abstract void execute()
                      throws RuleActionException

Execute the given rule action based on rules condition.

Parameters:

actionNode - the xml representation of the action

rule - the Rule in which the action is present

Throws:

RuleActionException