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

This session manages queries and sequencing to create "smart" dynamic catalogs. A RuleQuery can be retrieved from this session and mapped to this Engine to create a virtual collection of Rules. The rules may be sequenced using the RuleSearchOrder from this session.

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

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 associated with this session
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.
MethodgetRuleQuery
Description

Gets a rule query.

Returnosid.rules.RuleQuerythe rule query
CompliancemandatoryThis method must be implemented.
MethodgetRuleSearchOrder
Description

Gets a rule search order.

Returnosid.rules.RuleSearchOrderthe rule search order
CompliancemandatoryThis method must be implemented.
MethodapplyRuleQuery
Description

Applies a rule query to this engine.

Parametersosid.rules.RuleQueryruleQuerythe rule query
ErrorsNULL_ARGUMENT ruleQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED ruleQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectRuleQuery
Description

Gets a rule query inspector for this engine.

Returnosid.rules.RuleQueryInspectorthe rule query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyRuleSequencing
Description

Applies a rule search order to this engine.

Parametersosid.rules.RuleSearchOrderruleSearchOrderthe rule search order
ErrorsNULL_ARGUMENT ruleSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED ruleSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetRuleQueryFromInspector
Description

Gets a rule query from an inspector.

Parametersosid.rules.RuleQueryInspectorruleQueryInspectora rule query inspector
Returnosid.rules.RuleQuerythe rule query
ErrorsNULL_ARGUMENT ruleQueryInspector is null
UNSUPPORTED ruleQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.