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

This session manages queries and sequencing to create "smart" dynamic catalogs. An AgendaQuery can be retrieved from this session and mapped to this Engine to create a virtual collection of Agendas. The agendas may be sequenced using the AgendaSearchOrder from this session.

This Engine has a default query that matches any agenda and a default search order that specifies no sequencing. The queries may be examined using an AgendaQueryInspector. The query may be modified by converting the inspector back to an 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.
MethodcanManageSmartEngines
Description

Tests if this user can manage smart engines. A return of true does not guarantee successful authorization. A return of false indicates that it is known methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer operations to unauthorized users.

Returnboolean false if smart engine management is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetAgendaQuery
Description

Gets an agenda query.

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

Gets an agenda search order.

Returnosid.rules.check.AgendaSearchOrderthe agenda search order
CompliancemandatoryThis method must be implemented.
MethodapplyAgendaQuery
Description

Applies an agenda query to this engine.

Parametersosid.rules.check.AgendaQueryagendaQuerythe agenda query
ErrorsNULL_ARGUMENT agendaQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED agendaQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectAgendaQuery
Description

Gets an agenda query inspector for this engine.

Returnosid.rules.check.AgendaQueryInspectorthe agenda query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyAgendaSequencing
Description

Applies an agenda search order to this engine.

Parametersosid.rules.check.AgendaSearchOrderagendaSearchOrderthe agenda search order
ErrorsNULL_ARGUMENT agendaSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED agendaSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetAgendaQueryFromInspector
Description

Gets an agenda query from an inspector.

Parametersosid.rules.check.AgendaQueryInspectoragendaQueryInspectoran agenda query inspector
Returnosid.rules.check.AgendaQuerythe agenda query
ErrorsNULL_ARGUMENT agendaQueryInspector is null
UNSUPPORTED agendaQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.