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

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

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

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

Gets a controller query.

Returnosid.control.ControllerQuerythe controller query
CompliancemandatoryThis method must be implemented.
MethodgetControllerSearchOrder
Description

Gets a controller search order.

Returnosid.control.ControllerSearchOrderthe controller search order
CompliancemandatoryThis method must be implemented.
MethodapplyControllerQuery
Description

Applies a controller query to this system.

Parametersosid.control.ControllerQuerycontrollerQuerythe controller query
ErrorsNULL_ARGUMENT controllerQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED controllerQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspecControllerQuery
Description

Gets a controller query inspector for this system.

Returnosid.control.ControllerQueryInspectorthe controller query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyControllerSequencing
Description

Applies a controller search order to this system.

Parametersosid.control.ControllerSearchOrdercontrollerSearchOrderthe controller search order
ErrorsNULL_ARGUMENT controllerSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED controllerSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetControllerQueryFromInspector
Description

Gets a controller query from an inspector.

Parametersosid.control.ControllerQueryInspectorcontrollerQueryInspectora controller query inspector
Returnosid.control.ControllerQuerythe controller query
ErrorsNULL_ARGUMENT controllerQueryInspector is null
UNSUPPORTED controllerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.