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

This session manages queries and sequencing to create "smart" dynamic catalogs. A CheckQuery can be retrieved from this session and engineped to this Engine to create a virtual collection of Checks. The checks may be sequenced using the CheckSearchOrder from this session.

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

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

Gets a check query.

Returnosid.rules.check.CheckQuerythe check query
CompliancemandatoryThis method must be implemented.
MethodgetCheckSearchOrder
Description

Gets a check search order.

Returnosid.rules.check.CheckSearchOrderthe check search order
CompliancemandatoryThis method must be implemented.
MethodapplyCheckQuery
Description

Applies a check query to this engine.

Parametersosid.rules.check.CheckQuerycheckQuerythe check query
ErrorsNULL_ARGUMENT checkQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED checkQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectCheckQuery
Description

Gets a check query inspector for this engine.

Returnosid.rules.check.CheckQueryInspectorthe check query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyCheckSequencing
Description

Applies a check search order to this engine.

Parametersosid.rules.check.CheckSearchOrdercheckSearchOrderthe check search order
ErrorsNULL_ARGUMENT checkSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED checkSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetCheckQueryFromInspector
Description

Gets a check query from an inspector.

Parametersosid.rules.check.CheckQueryInspectorcheckQueryInspectora check query inspector
Returnosid.rules.check.CheckQuerythe check query
ErrorsNULL_ARGUMENT checkQueryInspector is null
UNSUPPORTED checkQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.