OSID Logo
OSID Specifications
control package
Version 3.0.0
Release Candidate Preview
Interfaceosid.control.TriggerSmartSystemSession
Implementsosid.OsidSession
Description

This session manages queries and sequencing to create "smart" dynamic catalogs. A TriggerQuery can be retrieved from this session and mapped to this System to create a virtual collection of Triggers. The triggers may be sequenced using the TriggerSearchOrder from this session.

This System has a default query that matches any trigger and a default search order that specifies no sequencing. The queries may be examined using a TriggerQueryInspector. The query may be modified by converting the inspector back to a TriggerQuery.

MethodgetSystemId
Description

Gets the System Id associated with this session.

Returnosid.id.Idthe System Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetSystem
Description

Gets the System associated with this session.

Returnosid.control.Systemthe system
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageSmartSystems
Description

Tests if this user can manage smart systems. 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 system management is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetTriggerQuery
Description

Gets a trigger query.

Returnosid.control.TriggerQuerythe trigger query
CompliancemandatoryThis method must be implemented.
MethodgetTriggerSearchOrder
Description

Gets a trigger search order.

Returnosid.control.TriggerSearchOrderthe trigger search order
CompliancemandatoryThis method must be implemented.
MethodapplyTriggerQuery
Description

Applies a trigger query to this system.

Parametersosid.control.TriggerQuerytriggerQuerythe trigger query
ErrorsNULL_ARGUMENT triggerQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED triggerQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectTriggerQuery
Description

Gets a trigger query inspector for this system.

Returnosid.control.TriggerQueryInspectorthe trigger query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyTriggerSequencing
Description

Applies a trigger search order to this system.

Parametersosid.control.TriggerSearchOrdertriggerSearchOrderthe trigger search order
ErrorsNULL_ARGUMENT triggerSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED triggerSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetTriggerQueryFromInspector
Description

Gets a trigger query from an inspector.

Parametersosid.control.TriggerQueryInspectortriggerQueryInspectora trigger query inspector
Returnosid.control.TriggerQuerythe trigger query
ErrorsNULL_ARGUMENT triggerQueryInspector is null
UNSUPPORTED triggerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.