OSID Logo
OSID Specifications
rules check package
Version 3.1.0
Interfaceosid.rules.check.CheckEvaluationSession
Implementsosid.OsidSession
Used Byosid.rules.check.RulesCheckManager
osid.rules.check.RulesCheckProxyManager
Description

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.

MethodgetEngineId
Description

Gets the Engine Id associated with this session.

Returnosid.id.Id the Engine Id associated with this session
Compliancemandatory This method must be implemented.
MethodgetEngine
Description

Gets the Engine associated with this session.

Returnosid.rules.Engine the engine
ErrorsOPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodcanEvaluateChecks
Description

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.

Returnboolean false if check evaluation is not authorized, true otherwise
Compliancemandatory This method must be implemented.
MethodgetCheckCondition
Description

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

Parametersosid.id.IdcheckId the Id of a Check
Returnosid.rules.check.CheckCondition a check condition
ErrorsNOT_FOUND checkId is not found
NULL_ARGUMENT checkId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure making request
Compliancemandatory This method must be implemented.
MethodevaluateCheckOnCondition
Description

Evaluates a check based on an input condition.

Parametersosid.id.IdcheckId the Id of a Check
osid.rules.check.CheckConditioncheckCondition a check condition
Returnboolean result of the evaluation
ErrorsNOT_FOUND checkId is not found
NULL_ARGUMENT checkId or checkCondition is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
UNSUPPORTED checkCondition did not otiginate from getCheckCondition()
Compliancemandatory This method must be implemented.