Interface RuleEvaluationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface RuleEvaluationSession
extends OsidSession

This session provides methods to evaluate and execute rules. An Condition is acquired for input into a Rule . The ConditionRecords in the Condition must be supplied to a specific Rule for its evaluation to be successful. Knowledge of a specific rule Id is also an agreement to the understanding of the required ConditionRecords as well as what is expected as a result. These record types may be inspected in the ConditionRecord and ResultRecord respectively.

Method Summary

Modifier and Type	Method	Description
boolean	canEvaluateRules()	Tests if this user can evaluate rules.
boolean	evaluateRuleOnCondition(Id ruleId, Condition condition)	Evaluates a rule based on an input condition abd returns a boolean result.
Result	executeRuleOnCondition(Id ruleId, Condition condition)	Executes a rule based on an input condition and returns a result.
Condition	getCondition(Id ruleId)	Gets a condition for the given rule.
Engine	getEngine()	Gets the Engine associated with this session.
Id	getEngineId()	Gets the Engine Id associated with this session.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getEngineId

Id getEngineId()

Gets the Engine Id associated with this session.

Returns:

the Engine Id associated with this session

Compliance:

mandatory - This method must be implemented.

getEngine

Engine getEngine()
          throws OperationFailedException,
PermissionDeniedException

Gets the Engine associated with this session.

Returns:

the engine

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canEvaluateRules

boolean canEvaluateRules()

Tests if this user can evaluate rules. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer these operations.

Returns:

false if evaluation methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getCondition

Condition getCondition(Id ruleId)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a condition for the given rule. The record Types in the Condition are required for a successful evaluation.

Parameters:

ruleId - the Id of a Rule

Returns:

the returned Condition

Throws:

NotFoundException - no Rule found with the given Id

NullArgumentException - ruleId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

evaluateRuleOnCondition

boolean evaluateRuleOnCondition(Id ruleId,
 Condition condition)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Evaluates a rule based on an input condition abd returns a boolean result.

Parameters:

ruleId - a rule Id

condition - input condition

Returns:

result of the evaluation

Throws:

NotFoundException - ruleId is not found

NullArgumentException - ruleId or condition is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - condition did not otiginate from getConditionForRule()

Compliance:

mandatory - This method must be implemented.

executeRuleOnCondition

Result executeRuleOnCondition(Id ruleId,
 Condition condition)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Executes a rule based on an input condition and returns a result.

Parameters:

ruleId - a rule Id

condition - input conditions

Returns:

result of the execution

Throws:

NotFoundException - an Id was not found

NullArgumentException - ruleId or condition is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - condition did not otiginate from getConditionForRule()

Compliance:

mandatory - This method must be implemented.