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

This session provides methods to re-assign Scenes to System mappings. A Scene may appear in multiple System objects and removing the last reference to a Scene is the equivalent of deleting it. Each System may have its own authorizations governing who is allowed to operate on it.

Adding a reference of a Scene to another System is not a copy operation (eg: does not change its Id ).

MethodcanAssignScenes
Description

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

Returnboolean false if scene is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanAssignScenesToSystem
Description

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

Parametersosid.id.IdsystemIdthe Id of the System
Returnboolean false if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENT systemId is null
CompliancemandatoryThis method must be implemented.
MethodgetAssignableSystemIds
Description

Gets a list of systems including and under the given system node in which any scene can be assigned.

Parametersosid.id.IdsystemIdthe Id of the System
Returnosid.id.IdListlist of assignable system Ids
ErrorsNULL_ARGUMENT systemId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetAssignableSystemIdsForScene
Description

Gets a list of systems including and under the given system node in which a specific scene can be assigned.

Parametersosid.id.IdsystemIdthe Id of the System
osid.id.IdsceneIdthe Id of the Scene
Returnosid.id.IdListlist of assignable system Ids
ErrorsNULL_ARGUMENT systemId or sceneId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignSceneToSystem
Description

Adds an existing Scene to a System.

Parametersosid.id.IdsceneIdthe Id of the Scene
osid.id.IdsystemIdthe Id of the System
ErrorsALREADY_EXISTS sceneId is already assigned to systemId
NOT_FOUND sceneId or systemId not found
NULL_ARGUMENT sceneId or systemId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignSceneFromSystem
Description

Removes a Scene from a System.

Parametersosid.id.IdsceneIdthe Id of the Scene
osid.id.IdsystemIdthe Id of the System
ErrorsNOT_FOUND sceneId or systemId not found or sceneId not assigned to systemId
NULL_ARGUMENT sceneId or systemId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignSceneToSystem
Description

Moves a Scene from one System to another. Mappings to other Systems are unaffected.

Parametersosid.id.IdsceneIdthe Id of the Scene
osid.id.IdfromSystemIdthe Id of the current System
osid.id.IdtoSystemIdthe Id of the destination System
ErrorsNOT_FOUND sceneId, fromSystemId, or toSystemId not found or sceneId not mapped to fromSystemId
NULL_ARGUMENT sceneId, fromSystemId, or toSystemId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.