| Interface | osid.rules.check.CheckEvaluationSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Used By | osid.rules.check.RulesCheckManager | ||
osid.rules.check.RulesCheckProxyManager | |||
| Description |
This session provides methods to evaluate
A | ||
| Method | getEngineId | ||
| Description |
Gets the | ||
| Return | osid.id.Id | the Engine Id associated with this session | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getEngine | ||
| Description |
Gets the | ||
| Return | osid.rules.Engine | the engine | |
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | canEvaluateChecks | ||
| 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 | ||
| Return | boolean | false if check evaluation is not authorized,
true otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCheckCondition | ||
| Description |
Gets a | ||
| Parameters | osid.id.Id | checkId | the Id of a Check |
| Return | osid.rules.check.CheckCondition | a check condition | |
| Errors | NOT_FOUND | checkId is not found | |
| NULL_ARGUMENT | checkId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure making request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | evaluateCheckOnCondition | ||
| Description |
Evaluates a check based on an input condition. | ||
| Parameters | osid.id.Id | checkId | the Id of a Check |
osid.rules.check.CheckCondition | checkCondition | a check condition | |
| Return | boolean | result of the evaluation | |
| Errors | NOT_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() | ||
| Compliance | mandatory | This method must be implemented. | |