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

This session manages queries and sequencing to create "smart" dynamic systems. An InputEnablerQuery can be retrieved from this session and mapped to this System to create a virtual collection of input enablers. The input enablers may be sequenced using the InputEnablerSearchOrder from this session.

This System has a default query that matches any input enabler and a default search order that specifies no sequencing. The queries may be examined using an InputEnablerQueryInspector. The query may be modified by converting the inspector back to an InputEnablerQuery.

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

Gets an input enabler query.

Returnosid.control.rules.InputEnablerQuerythe input enabler query
CompliancemandatoryThis method must be implemented.
MethodgetInputEnablerSearchOrder
Description

Gets an input enabler search order.

Returnosid.control.rules.InputEnablerSearchOrderthe input enabler search order
CompliancemandatoryThis method must be implemented.
MethodapplyInputEnablerQuery
Description

Applies an input enabler query to this system.

Parametersosid.control.rules.InputEnablerQueryinputEnablerQuerythe input enabler query
ErrorsNULL_ARGUMENT inputEnablerQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED inputEnablerQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectInputEnablerQuery
Description

Gets an input enabler query inspector for this system.

Returnosid.control.rules.InputEnablerQueryInspectorthe input enabler query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyInputEnablerSequencing
Description

Applies an input enabler search order to this system.

Parametersosid.control.rules.InputEnablerSearchOrderinputEnablerSearchOrderthe input enabler search order
ErrorsNULL_ARGUMENT inputEnablerSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED inputEnablerSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetInputEnablerQueryFromInspector
Description

Gets an input enabler query from an inspector.

Parametersosid.control.rules.InputEnablerQueryInspectorinputEnablerQueryInspectoran input enabler query inspector
Returnosid.control.rules.InputEnablerQuerythe input enabler query
ErrorsNULL_ARGUMENT inputEnablerQueryInspector is null
UNSUPPORTED inputEnablerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.