org.osid.rules

Interface RulesSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface RulesSession
extends OsidSession

This session provides methods to evaluate and execute rules.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canEvaluateRules() Tests if this user can evaluate rules.
boolean	evaluateRule(Id ruleId, Condition condition) Evaluates a rule based on an input condition.
Result	executeRule(Id ruleId, Condition condition) Executes a rule based on an input condition and returns a result.
Condition	getConditionForRule(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 org.osid.OsidSession

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

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

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.

getConditionForRule

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

Gets a condition for the given rule.

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.

evaluateRule

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

Evaluates a rule based on an input condition.

Parameters:

ruleId - a rule Id

condition - input conditions

Returns:

result of the evaluation

Throws:

NotFoundException - an Id was not found

NullArgumentException - ruleId or condition is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - condition not of this service

Compliance:

mandatory - This method must be implemented.

executeRule

Result executeRule(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 not of this service

Compliance:

mandatory - This method must be implemented.