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

This session manages queries and sequencing to create "smart" dynamic catalogs. A SceneQuery can be retrieved from this session and systemped to this System to create a virtual collection of Scenes. The scenes may be sequenced using the SceneSearchOrder from this session.

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

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

Gets a scene query.

Returnosid.control.SceneQuerythe scene query
CompliancemandatoryThis method must be implemented.
MethodgetSceneSearchOrder
Description

Gets a scene search order.

Returnosid.control.SceneSearchOrderthe scene search order
CompliancemandatoryThis method must be implemented.
MethodapplySceneQuery
Description

Applies a scene query to this system.

Parametersosid.control.SceneQuerysceneQuerythe scene query
ErrorsNULL_ARGUMENT sceneQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED sceneQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectSceneQuery
Description

Gets a scene query inspector for this system.

Returnosid.control.SceneQueryInspectorthe scene query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplySceneSequencing
Description

Applies a scene search order to this system.

Parametersosid.control.SceneSearchOrdersceneSearchOrderthe scene search order
ErrorsNULL_ARGUMENT sceneSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED sceneSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetSceneQueryFromInspector
Description

Gets a scene query from an inspector.

Parametersosid.control.SceneQueryInspectorsceneQueryInspectora scene query inspector
Returnosid.control.SceneQuerythe scene query
ErrorsNULL_ARGUMENT sceneQueryInspector is null
UNSUPPORTED sceneQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.