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

This session provides methods for searching among Agenda objects. The search query is constructed using the AgendaQuery.

This session defines views that offer differing behaviors for searching.

  • federated engine view: searches include agendas in engines of which this engine is an ancestor in the engine hierarchy
  • isolated engine view: searches are restricted to agendas in this engine

Agendas may have a query record indicated by their respective record types. The query record is accessed via the AgendaQuery.

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.
MethodcanSearchAgendas
Description

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

Federates the view for methods in this session. A federated view will include agendas in engine which are children of this engine in the engine hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedEngineView
Description

Isolates the view for methods in this session. An isolated view restricts searches to this engine only.

CompliancemandatoryThis method is must be implemented.
MethodgetAgendaQuery
Description

Gets an agenda query.

Returnosid.rules.check.AgendaQuerythe agenda query
CompliancemandatoryThis method must be implemented.
MethodgetAgendasByQuery
Description

Gets a list of Agendas matching the given agenda query.

Parametersosid.rules.check.AgendaQueryagendaQuerythe agenda query
Returnosid.rules.check.AgendaListthe returned AgendaList
ErrorsNULL_ARGUMENT agendaQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED agendaQuery is not of this service
CompliancemandatoryThis method must be implemented.