OSID Logo
OSID Specifications
control package
Version 3.1.0
Interfaceosid.control.TriggerSmartSystemSession
Implementsosid.OsidSession
Used Byosid.control.ControlManager
osid.control.ControlProxyManager
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.Id the System Id associated with this session
Compliancemandatory This method must be implemented.
MethodgetSystem
Description

Gets the System associated with this session.

Returnosid.control.System the system
ErrorsOPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This 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
Compliancemandatory This method must be implemented.
MethodgetTriggerQuery
Description

Gets a trigger query.

Returnosid.control.TriggerQuery the trigger query
Compliancemandatory This method must be implemented.
MethodgetTriggerSearchOrder
Description

Gets a trigger search order.

Returnosid.control.TriggerSearchOrder the trigger search order
Compliancemandatory This method must be implemented.
MethodapplyTriggerQuery
Description

Applies a trigger query to this system.

Parametersosid.control.TriggerQuerytriggerQuery the trigger query
ErrorsNULL_ARGUMENT triggerQuery is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
UNSUPPORTED triggerQuery not of this service
Compliancemandatory This method must be implemented.
MethodinspectTriggerQuery
Description

Gets a trigger query inspector for this system.

Returnosid.control.TriggerQueryInspector the trigger query inspector
ErrorsOPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
Compliancemandatory This method must be implemented.
MethodapplyTriggerSequencing
Description

Applies a trigger search order to this system.

Parametersosid.control.TriggerSearchOrdertriggerSearchOrder the trigger search order
ErrorsNULL_ARGUMENT triggerSearchOrder is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
UNSUPPORTED triggerSearchOrder not of this service
Compliancemandatory This method must be implemented.
MethodgetTriggerQueryFromInspector
Description

Gets a trigger query from an inspector.

Parametersosid.control.TriggerQueryInspectortriggerQueryInspector a trigger query inspector
Returnosid.control.TriggerQuery the trigger query
ErrorsNULL_ARGUMENT triggerQueryInspector is null
UNSUPPORTED triggerQueryInspector is not of this service
Compliancemandatory This method must be implemented.