com.haley.haleyrules.jsr94
Class HaleyRuleSession

java.lang.Object
  |
  +--com.haley.haleyrules.jsr94.HaleyRuleSession

All Implemented Interfaces:

javax.rules.RuleSession

Direct Known Subclasses:

StatefulRuleSessionImpl, StatelessRuleSessionImpl

public abstract class HaleyRuleSession

extends java.lang.Object

implements javax.rules.RuleSession

The HaleyRuleSession captures the common features of the session in a HaleyRule engine, no matter if it is a stateless session or a stateful session. The StatefulRuleSession and the StatelessRuleSession of Haley's implementation extend this class

Method Summary

javax.rules.RuleExecutionSetMetadata	getRuleExecutionSetMetadata() Returns the meta data for the rule execution set bound to this rule session
abstract int	getType() Gets the type of the session
void	release() Releases all resources used by this rule session.

Methods inherited from class java.lang.Object

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

Method Detail

getRuleExecutionSetMetadata

public javax.rules.RuleExecutionSetMetadata getRuleExecutionSetMetadata()
                                                                 throws javax.rules.InvalidRuleSessionException

Returns the meta data for the rule execution set bound to this rule session

Specified by:

getRuleExecutionSetMetadata in interface javax.rules.RuleSession

Returns:

RuleExecutionSetMetadata the RuleExecutionSetMetaData bound to this rule session.

Throws:

javax.rules.InvalidRuleSessionException - on illegal rule session state

getType

public abstract int getType()
                     throws javax.rules.InvalidRuleSessionException

Gets the type of the session

Specified by:

getType in interface javax.rules.RuleSession

Returns:

the type identifier for this RuleSession. The type identifiers are defined in the RuleRuntime interface

Throws:

javax.rules.InvalidRuleSessionException - on illegal rule session state

release

public void release()
             throws javax.rules.InvalidRuleSessionException

Releases all resources used by this rule session. This method renders this rule session unusable until it is reacquired through the RuleRuntime.

Specified by:

release in interface javax.rules.RuleSession

Throws:

javax.rules.InvalidRuleSessionException - on illegal rule session state