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

This is a session for checking 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.
MethodcanAccessAgendas
Description

Tests if this user can perform Agenda 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 agenda methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetInstructionsForProcessing
Description

Gets al ist of instructions for processing. This method returns a filtered list of active Instructions based on the demographic and time criteria in the instruction but performs no evaluation on the Checks. An empty list is a successful evaluation.

Parametersosid.id.IdagendaIdthe Id of an Agenda
osid.id.IdresourceIdthe Id of a Resource to be applied to a Demographic
timestampnowthe date to apply
Returnosid.rules.check.InstructionLista list of instructions
ErrorsNOT_FOUND agendaId is not found
NULL_ARGUMENT agendaId, resourceId, or now is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure making request
CompliancemandatoryThis method must be implemented.