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

This session manages queries and sequencing to create "smart" dynamic catalogs. An ActionGroupQuery can be retrieved from this session and mapped to this System to create a virtual collection of ActionGroups. The action groups may be sequenced using the ActionGroupSearchOrder from this session.

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

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

Gets an action group query.

Returnosid.control.ActionGroupQuerythe action group query
CompliancemandatoryThis method must be implemented.
MethodgetActionGroupSearchOrder
Description

Gets an action group search order.

Returnosid.control.ActionGroupSearchOrderthe action group search order
CompliancemandatoryThis method must be implemented.
MethodapplyActionGroupQuery
Description

Applies an action group query to this system.

Parametersosid.control.ActionGroupQueryactuionGroupQuerythe action group query
ErrorsNULL_ARGUMENT actuionGroupQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED actuionGroupQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectActionGroupQuery
Description

Gets an action group query inspector for this system.

Returnosid.control.ActionGroupQueryInspectorthe action group query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyActionGroupSequencing
Description

Applies an action group search order to this system.

Parametersosid.control.ActionGroupSearchOrderactionGroupSearchOrderthe action group search order
ErrorsNULL_ARGUMENT actionGroupSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED actionGroupSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetActionGroupQueryFromInspector
Description

Gets an action group query from an inspector.

Parametersosid.control.ActionGroupQueryInspectoractuionGroupQueryInspectoran action group query inspector
Returnosid.control.ActionGroupQuerythe action group query
ErrorsNULL_ARGUMENT actuionGroupQueryInspector is null
UNSUPPORTED actuionGroupQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.