RuleSession (OpenText Process Suite Platform 10.8 Java SDK API)

```
public interface RuleSession
```
The RuleSession has to be created by the rule engine host to evaluate rules for a set of conditions. RuleSession can be created by invoking any of the following APIs.
Once the RuleSession is created, to execute rules or decision case, client is expected to call executeRules() or executeDecisionCase(String) method respectively. Finally, cleanUp() has to be called to clean up all the NOM node pointers created for the objects in the rule session.
Note: User should be a valid LDAP user
For example, user = "cn=john,cn=organizational users,o=system,cn=cordys,cn=defaultInst,o=vanenburg.com"
Sample code :
```
 RuleSession ruleSession = ruleEngine.createRuleSession(uriBinding, ruleType, triggerEvent, user);
 XObject xObject = new XObjectImpl(Node.getFirstChild(iObjects));
 ruleSession.setTriggerObject(xObject);
 ruleSession.setTransactionContext(null); // transaction object if any
 try
 {
        ruleSession.executeRules();//Marks the actual start of a rule execution cycle
 }
 finally
 {
        ruleSession.cleanUp();
 }
 
```

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`actionExecuted()` Returns whether any action was taken as part of the rule execution
`int`	`addObject(XObject object)` Add the xobject to the rule session context.
`void`	`cleanUp()` To clean up the rulesession after (executeRules method)executing the rules.If a cleanUp is called by the client after calling execute rules there is a possibility of memory leak as NOM nodes
`void`	`disableRuleMonitoring()` Use this API to disable rule monitoring.
`void`	`enableRuleMonitoring()` Use this API to turn ON Rule Monitoring.
`int`	`executeDecisionCase(java.lang.String dcId)` Executes the decision case whose Id is passed.
`void`	`executeRules()` Executes the rules as applicable to this rule session.
`XObject`	`getObject(java.lang.String xobjectIdentifer)` Gets the xobject from rule session context.
`int`	`getObjectContext()` Gets the int objects node from rule session used for rule evaluation.
`java.lang.String`	`getOrgContext()` Returns the organizational context associated with this `RuleSession`
`RuleEngine`	`getRuleEngine()` Returns the `RuleEngine` in which the rule session executes.
`IRuleSet`	`getRuleSet()` Gets the ruleset from rule session used for rule evaluation.
`java.lang.String`	`getRuleType()` Returns the type of rules for the current rule execution cycle
`java.lang.String`	`getSessionId()` returns the rule session id
`java.lang.Object`	`getTransactionContext()` Returns the transaction context associated with this rule session
`java.lang.String`	`getTransactionId()` Returns the transaction id associated with this rule session
`TriggerEvents`	`getTriggerEvent()`
`XObject`	`getTriggerObject()` Returns the trigger object for the rule.
`java.lang.String`	`getUriBinding()` Returns the URI Binding for the current rule execution cycle
`java.lang.String`	`getUser()` Returns the user associated with this `RuleSession`
`int`	`getXmlObjectFromContext(java.lang.String tagname, java.lang.String namespace)` Gets the int object node from rule session context by xml tagname and namesapce.
`boolean`	`hasSatifiedRuleCondition()` Returns whether any if/condition of rules in the ruleset has satisfied condition as part of rule execution
`boolean`	`isRuleMonitoringEnabled()` This method overrides the rule monitoring value set at a global level i.e.
`boolean`	`isTriggerObject(java.lang.String xobjectIdentifer)`
`void`	`refreshXObjects()` Refreshs the xobjects in the context of the rule session
`void`	`removeObject(java.lang.String xobjectIdentifer)` Removes the xobject from rule session context.
`void`	`removeObject(XObject object)` Removes the xobject from rule session context.
`void`	`setActionExecuted(java.lang.String actionname)` Sets action executed flag to true for actionname, this is internally set by rule-engine when any action is taken while evaluation
`void`	`setTransactionContext(java.lang.Object transaction)` Sets the transaction context on the rule session .This could be any object implementation for the host transaction .
`void`	`setTransactionId(java.lang.String transactionId)` Sets the transaction id on the rule session.
`void`	`setTriggerObject(XObject object)` Sets the object triggering the rule.
`void`	`setUser(java.lang.String user)` Deprecated.

- Method Detail
  - getSessionId
```
java.lang.String getSessionId()
```
    returns the rule session id
    
    Returns:
    
    unique id for the rule session
  - getRuleEngine
```
RuleEngine getRuleEngine()
```
    Returns the RuleEngine in which the rule session executes.
    
    Returns:
    
    rule engine RuleEngine
  - getRuleType
```
java.lang.String getRuleType()
```
    Returns the type of rules for the current rule execution cycle
    
    Returns:
    
    the type of rules for the current rule execution cycle
  - getUriBinding
```
java.lang.String getUriBinding()
```
    Returns the URI Binding for the current rule execution cycle
    
    Returns:
    
    the binding URI for the current rule execution cycle
  - setTriggerObject
```
void setTriggerObject(XObject object)
```
    Sets the object triggering the rule.
    
    Parameters:
    
    The - object XObject passed to the rule engine for applying the rules.
  - getTriggerObject
```
XObject getTriggerObject()
```
    Returns the trigger object for the rule.
    
    Returns:
    
    The trigger object XObject for the current rule session
  - isTriggerObject
```
boolean isTriggerObject(java.lang.String xobjectIdentifer)
```
  - addObject
```
int addObject(XObject object)
```
    Add the xobject to the rule session context.
    
    Parameters:
    
    The - object XObject to be added to the context
  - removeObject
```
void removeObject(XObject object)
```
    Removes the xobject from rule session context.
    
    Parameters:
    
    The - object XObject to be removed from the context
  - removeObject
```
void removeObject(java.lang.String xobjectIdentifer)
```
    Removes the xobject from rule session context.
    
    Parameters:
    
    The - String identifier for the XObject to be removed from the context
  - getObject
```
XObject getObject(java.lang.String xobjectIdentifer)
```
    Gets the xobject from rule session context.
    
    Parameters:
    
    The - String identifier for the XObject to be fetched from the context
  - refreshXObjects
```
void refreshXObjects()
```
    Refreshs the xobjects in the context of the rule session
  - getXmlObjectFromContext
```
int getXmlObjectFromContext(java.lang.String tagname,
                            java.lang.String namespace)
```
    Gets the int object node from rule session context by xml tagname and namesapce.
    
    Parameters:
    
    string - tagname
    
    namespace - of the xml node that is to be retrieved
  - getRuleSet
```
IRuleSet getRuleSet()
```
    Gets the ruleset from rule session used for rule evaluation.
    
    Returns:
    
    ruleset IRuleSet which is used for rule evaluation
  - getObjectContext
```
int getObjectContext()
```
    Gets the int objects node from rule session used for rule evaluation.
    
    Returns:
    
    int Node pointer to the objects used in rule session
  - setTransactionContext
```
void setTransactionContext(java.lang.Object transaction)
```
    Sets the transaction context on the rule session .This could be any object implementation for the host transaction .
    
    Parameters:
    
    Object - - the transaction object
  - setTransactionId
```
void setTransactionId(java.lang.String transactionId)
```
    Sets the transaction id on the rule session.
    
    Parameters:
    
    transactionId -
  - getTransactionId
```
java.lang.String getTransactionId()
```
    Returns the transaction id associated with this rule session
    
    Returns:
    
    the transaction id with this rule session
  - getTransactionContext
```
java.lang.Object getTransactionContext()
```
    Returns the transaction context associated with this rule session
    
    Returns:
    
    the transaction associated with this rule session
  - getUser
```
java.lang.String getUser()
```
    Returns the user associated with this RuleSession
    
    Returns:
    
    the user associated with this RuleSession
  - setUser
```
@Deprecated
void setUser(java.lang.String user)
```
    Deprecated.
    
    Rule Engine clients can set the user context for the current rule execution cycle.
    
    Parameters:
    
    user - the user context for the current rule execution cycle.User should be a valid LDAP user
    For example, user = "cn=john,cn=organizational users,o=system,cn=cordys,cn= defaultInst,o=vanenburg.com"
  - executeRules
```
void executeRules()
           throws RuleExecutionException
```
    Executes the rules as applicable to this rule session.
    
    Throws:
    
    RuleExecutionException
  - executeDecisionCase
```
int executeDecisionCase(java.lang.String dcId)
                 throws RuleExecutionException
```
    Executes the decision case whose Id is passed.
    
    Parameters:
    
    dcId -
    
    Returns:
    
    a node with the name of the decision case having changed Object and execution id. example: 63272637263 20% CalculateDiscountDecisioncase : Name of the decision case 20% is the changed object
    
    Throws:
    
    RuleExecutionException
  - actionExecuted
```
boolean actionExecuted()
```
    Returns whether any action was taken as part of the rule execution
  - hasSatifiedRuleCondition
```
boolean hasSatifiedRuleCondition()
```
    Returns whether any if/condition of rules in the ruleset has satisfied condition as part of rule execution
  - setActionExecuted
```
void setActionExecuted(java.lang.String actionname)
```
    Sets action executed flag to true for actionname, this is internally set by rule-engine when any action is taken while evaluation
  - cleanUp
```
void cleanUp()
```
    To clean up the rulesession after (executeRules method)executing the rules.If a cleanUp is called by the client after calling execute rules there is a possibility of memory leak as NOM nodes
  - getOrgContext
```
java.lang.String getOrgContext()
```
    Returns the organizational context associated with this RuleSession
    
    Returns:
    
    the orgContext associated with this RuleSession
  - isRuleMonitoringEnabled
```
boolean isRuleMonitoringEnabled()
```
    This method overrides the rule monitoring value set at a global level i.e. at RuleEngine instance
    
    Returns:
    
    true when Rule monitoring is enabled for this session; false otherwise. This is influenced by #enableRuleMonitoring(boolean) API. If #enableRuleMonitoring(boolean) is never called then global configuration is considered
  - enableRuleMonitoring
```
void enableRuleMonitoring()
```
    Use this API to turn ON Rule Monitoring.
    Rule monitoring setting is available
    - at Rule Engine level (Global setting); applies to all rule sessions
    - at each Rule Session. Rule Session property that overrides global property value.
    A sample use case is when a BPM executes a series of decision table activities it might want to monitor only a specific decision table activity; rest of the decision table activities need not be monitored. This is where BPM framework will influence the default rule monitoring property using this API
  - disableRuleMonitoring
```
void disableRuleMonitoring()
```
    Use this API to disable rule monitoring. This API overwrites global rule monitoring setting
  - getTriggerEvent
```
TriggerEvents getTriggerEvent()
```
    Returns:
    
    the triggering event information for this rule session

Interface RuleSession

Method Summary

Method Detail

getSessionId

getRuleEngine

getRuleType

getUriBinding

setTriggerObject

getTriggerObject

isTriggerObject

addObject

removeObject

removeObject

getObject

refreshXObjects

getXmlObjectFromContext

getRuleSet

getObjectContext

setTransactionContext

setTransactionId

getTransactionId

getTransactionContext

getUser

setUser

executeRules

executeDecisionCase

actionExecuted

hasSatifiedRuleCondition

setActionExecuted

cleanUp

getOrgContext

isRuleMonitoringEnabled

enableRuleMonitoring

disableRuleMonitoring

getTriggerEvent