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

This session provides methods to retrieve Scene to System scenes. A Scene may appear in multiple System objects. Each system may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
MethodcanLookupSceneSystemScenes
Description

Tests if this user can perform lookups of scene/system mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 lookup operations to unauthorized users.

Returnboolean false if looking up scenes is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeSceneSystemView
Description

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

CompliancemandatoryThis method is must be implemented.
MethodusePlenarySceneSystemView
Description

A complete view of the Scene and System returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is must be implemented.
MethodgetSceneIdsBySystem
Description

Gets the list of Scene Ids associated with a System.

Parametersosid.id.IdsystemId Id of the System
Returnosid.id.IdListlist of related scene Ids
ErrorsNOT_FOUND systemId is not found
NULL_ARGUMENT systemId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetScenesBySystem
Description

Gets the list of Scenes associated with a System.

Parametersosid.id.IdsystemId Id of the System
Returnosid.control.SceneListlist of related scenes
ErrorsNOT_FOUND systemId is not found
NULL_ARGUMENT systemId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSceneIdsBySystems
Description

Gets the list of Scene Ids corresponding to a list of Systems.

Parametersosid.id.IdListsystemIdslist of system Ids
Returnosid.id.IdListlist of scene Ids
ErrorsNULL_ARGUMENT systemIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetScenesBySystems
Description

Gets the list of Scenes corresponding to a list of Systems.

Parametersosid.id.IdListsystemIdslist of system Ids
Returnosid.control.SceneListlist of scenes
ErrorsNULL_ARGUMENT systemIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSystemIdsByScene
Description

Gets the System Ids mapped to a Scene.

Parametersosid.id.IdsceneId Id of a Scene
Returnosid.id.IdListlist of systems
ErrorsNOT_FOUND sceneId is not found
NULL_ARGUMENT sceneId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSystemsByScene
Description

Gets the Systems mapped to a Scene.

Parametersosid.id.IdsceneId Id of a Scene
Returnosid.control.SystemListlist of systems
ErrorsNOT_FOUND sceneId is not found
NULL_ARGUMENT sceneId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.