Interface CheckEvaluationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface CheckEvaluationSession
extends OsidSession

This session provides methods to evaluate Checks . Checks are OsidRules that may require additional input in the form of a CheckCondition to be evaluated.

A CheckCondition is acquired using getCheckCondition() . The CheckConditionRecords in the CheckCondition must be supplied for a successful evaluation. Knowledge of a specific check Id is also an agreement to the understanding of the required CheckConditionRecords as well as what is expected as a result. These record Types may be inspected in the CheckConditionRecord and CheckResultRecord respectively.

Method Summary

Modifier and Type	Method	Description
boolean	canEvaluateChecks()	Tests if this user can evaluate checks.
boolean	evaluateCheckOnCondition(Id checkId, CheckCondition checkCondition)	Evaluates a check based on an input condition.
CheckCondition	getCheckCondition(Id checkId)	Gets a CheckCondition for the given Check .
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.

canEvaluateChecks

boolean canEvaluateChecks()

Tests if this user can evaluate checks. 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 not offer lookup operations to unauthorized users.

Returns:

false if check evaluation is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getCheckCondition

CheckCondition getCheckCondition(Id checkId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a CheckCondition for the given Check . The record Types in the CheckCondition are required for a successful evaluation.

Parameters:

checkId - the Id of a Check

Returns:

a check condition

Throws:

NotFoundException - checkId is not found

NullArgumentException - checkId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure making request

Compliance:

mandatory - This method must be implemented.

evaluateCheckOnCondition

boolean evaluateCheckOnCondition(Id checkId,
 CheckCondition checkCondition)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Evaluates a check based on an input condition.

Parameters:

checkId - the Id of a Check

checkCondition - a check condition

Returns:

result of the evaluation

Throws:

NotFoundException - checkId is not found

NullArgumentException - checkId or checkCondition is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - checkCondition did not otiginate from getCheckCondition()

Compliance:

mandatory - This method must be implemented.