Interface | osid.control.SceneSystemAssignmentSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to re-assign Adding a reference of a | ||
Method | canAssignScenes | ||
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
| ||
Return | boolean | false if scene is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canAssignScenesToSystem | ||
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
| ||
Parameters | osid.id.Id | systemId | the Id of the System |
Return | boolean | false if mapping is not authorized, true
otherwise | |
Errors | NULL_ARGUMENT | systemId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getAssignableSystemIds | ||
Description |
Gets a list of systems including and under the given system node in which any scene can be assigned. | ||
Parameters | osid.id.Id | systemId | the Id of the System |
Return | osid.id.IdList | list of assignable system Ids | |
Errors | NULL_ARGUMENT | systemId is null | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssignableSystemIdsForScene | ||
Description |
Gets a list of systems including and under the given system node in which a specific scene can be assigned. | ||
Parameters | osid.id.Id | systemId | the Id of the System |
osid.id.Id | sceneId | the Id of the Scene | |
Return | osid.id.IdList | list of assignable system Ids | |
Errors | NULL_ARGUMENT | systemId or sceneId is null | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | assignSceneToSystem | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | sceneId | the Id of the Scene |
osid.id.Id | systemId | the Id of the System | |
Errors | ALREADY_EXISTS | sceneId is already assigned to systemId | |
NOT_FOUND | sceneId or systemId not found | ||
NULL_ARGUMENT | sceneId or systemId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignSceneFromSystem | ||
Description |
Removes a | ||
Parameters | osid.id.Id | sceneId | the Id of the Scene |
osid.id.Id | systemId | the Id of the System | |
Errors | NOT_FOUND | sceneId or systemId not found or
sceneId not assigned to systemId | |
NULL_ARGUMENT | sceneId or systemId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | reassignSceneToSystem | ||
Description |
Moves a | ||
Parameters | osid.id.Id | sceneId | the Id of the Scene |
osid.id.Id | fromSystemId | the Id of the current System | |
osid.id.Id | toSystemId | the Id of the destination System | |
Errors | NOT_FOUND | sceneId, fromSystemId, or toSystemId not
found or sceneId not mapped to fromSystemId | |
NULL_ARGUMENT | sceneId, fromSystemId, or toSystemId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |