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

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

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

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

Gets an action enabler query.

Returnosid.control.rules.ActionEnablerQuerythe action enabler query
CompliancemandatoryThis method must be implemented.
MethodgetActionEnablerSearchOrder
Description

Gets an action enabler search order.

Returnosid.control.rules.ActionEnablerSearchOrderthe action enabler search order
CompliancemandatoryThis method must be implemented.
MethodapplyActionEnablerQuery
Description

Applies an action enabler query to this system.

Parametersosid.control.rules.ActionEnablerQueryactionEnablerQuerythe action enabler query
ErrorsNULL_ARGUMENT actionEnablerQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED actionEnablerQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectActionEnablerQuery
Description

Gets an action enabler query inspector for this system.

Returnosid.control.rules.ActionEnablerQueryInspectorthe action enabler query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyActionEnablerSequencing
Description

Applies an action enabler search order to this system.

Parametersosid.control.rules.ActionEnablerSearchOrderactionEnablerSearchOrderthe action enabler search order
ErrorsNULL_ARGUMENT actionEnablerSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED actionEnablerSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetActionEnablerQueryFromInspector
Description

Gets an action enabler query from an inspector.

Parametersosid.control.rules.ActionEnablerQueryInspectoractionEnablerQueryInspectoran action enabler query inspector
Returnosid.control.rules.ActionEnablerQuerythe action enabler query
ErrorsNULL_ARGUMENT actionEnablerQueryInspector is null
UNSUPPORTED actionEnablerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.