Interface | osid.rules.check.EvaluationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This is the session for evaluating agendas. | ||
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 | canEvaluate | ||
Description |
Tests if this user can perform evaluations. 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 agenda methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getCondition | ||
Description |
Gets the | ||
Parameters | osid.id.Id | agendaId | the Id of a Agenda |
Return | osid.rules.Condition | a condition | |
Errors | NOT_FOUND | agendaId is not found | |
NULL_ARGUMENT | agendaId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure making request | ||
Compliance | mandatory | This method must be implemented. | |
Method | evaluateAgenda | ||
Description |
Evaluates an agenda. | ||
Parameters | osid.id.Id | agendaId | the Id of an Agenda |
osid.id.Id | resourceId | the Id of a Resource to be applied to a
Demographic | |
timestamp | now | the date to apply | |
osid.rules.Condition | condition | a condition | |
Return | osid.rules.check.CheckResultList | a list of results or empty if successful | |
Errors | NOT_FOUND | agendaId is not found | |
NULL_ARGUMENT | agendaId, resourceId, now , or
condition is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure making request | ||
UNSUPPORTED | condition is not of this service | ||
Compliance | mandatory | This method must be implemented. |