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

This session manages queries and sequencing to create "smart" dynamic catalogs. An InstructionQuery can be retrieved from this session and engineped to this Engine to create a virtual collection of Instructions. The instructions may be sequenced using the InstructionSearchOrder from this session.

This Engine has a default query that matches any instruction and a default search order that specifies no sequencing. The queries may be examined using an InstructionQueryInspector. The query may be modified by converting the inspector back to an InstructionQuery.

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

Gets an instruction query.

Returnosid.rules.check.InstructionQuerythe instruction query
CompliancemandatoryThis method must be implemented.
MethodgetInstructionSearchOrder
Description

Gets an instruction search order.

Returnosid.rules.check.InstructionSearchOrderthe instruction search order
CompliancemandatoryThis method must be implemented.
MethodapplyInstructionQuery
Description

Applies an instruction query to this engine.

Parametersosid.rules.check.InstructionQueryinstructionQuerythe instruction query
ErrorsNULL_ARGUMENT instructionQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED instructionQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspecInstructionQuery
Description

Gets an instruction query inspector for this engine.

Returnosid.rules.check.InstructionQueryInspectorthe instruction query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyInstructionSequencing
Description

Applies an instruction search order to this engine.

Parametersosid.rules.check.InstructionSearchOrderinstructionSearchOrderthe instruction search order
ErrorsNULL_ARGUMENT instructionSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED instructionSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetInstructionQueryFromInspector
Description

Gets an instruction query from an inspector.

Parametersosid.rules.check.InstructionQueryInspectorinstructionQueryInspectoran instruction query inspector
Returnosid.rules.check.InstructionQuerythe instruction query
ErrorsNULL_ARGUMENT instructionQueryInspector is null
UNSUPPORTED instructionQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.