OSID Logo
OSID Specifications
rules check package
Version 3.0.0
Release Candidate Preview
Interfaceosid.rules.check.EvaluationSession
Implementsosid.OsidSession
Description

This is the session for evaluating agendas.

MethodgetEngineId
Description

Gets the Engine Id associated with this session.

Returnosid.id.Idthe Engine Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetEngine
Description

Gets the Engine associated with this session.

Returnosid.rules.Enginethe engine
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanEvaluate
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 PERMISSION_DENIED. This is intended as a hint to an application that may not offer lookup operations to unauthorized users.

Returnboolean false if agenda methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetCondition
Description

Gets the Condition to supply data to the evaluation. The condition supplies all the records aligning with the inputs of the Check rules.

Parametersosid.id.IdagendaIdthe Id of a Agenda
Returnosid.rules.Conditiona condition
ErrorsNOT_FOUND agendaId is not found
NULL_ARGUMENT agendaId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure making request
CompliancemandatoryThis method must be implemented.
MethodevaluateAgenda
Description

Evaluates an agenda.

Parametersosid.id.IdagendaIdthe Id of an Agenda
osid.id.IdresourceIdthe Id of a Resource to be applied to a Demographic
timestampnowthe date to apply
osid.rules.Conditionconditiona condition
Returnosid.rules.check.CheckResultLista list of results or empty if successful
ErrorsNOT_FOUND agendaId is not found
NULL_ARGUMENT agendaId, resourceId, now , or condition is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure making request
UNSUPPORTED condition is not of this service
CompliancemandatoryThis method must be implemented.