Interface | osid.control.SceneAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create a For updates, The delete operations delete This session includes an | ||
Method | getSystemId | ||
Description |
Gets the | ||
Return | osid.id.Id | the System Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getSystem | ||
Description |
Gets the | ||
Return | osid.control.System | the system | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canCreateScenes | ||
Description |
Tests if this user can create scenes. A return of true
does not guarantee successful authorization. A return of
false indicates that it is known creating a | ||
Return | boolean | false if Scene creation is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateSceneWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | sceneRecordTypes | array of scene record types |
Return | boolean | true if Scene creation using the specified
record Types is supported, false otherwise | |
Errors | NULL_ARGUMENT | sceneRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getSceneFormForCreate | ||
Description |
Gets the scene form for creating new scenes. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | sceneRecordTypes | array of scene record types |
Return | osid.control.SceneForm | the scene form | |
Errors | NULL_ARGUMENT | sceneRecordTypes is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to get form for requested record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createScene | ||
Description |
Creates a new | ||
Parameters | osid.control.SceneForm | sceneForm | the form for this Scene |
Return | osid.control.Scene | the new Scene | |
Errors | ILLEGAL_STATE | sceneForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NOT_FOUND | resourceId or actionId is not found | ||
NULL_ARGUMENT | sceneForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | sceneForm did not originate from
getSceneFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateScenes | ||
Description |
Tests if this user can update scenes. A return of true
does not guarantee successful authorization. A return of
false indicates that it is known updating a | ||
Return | boolean | false if Scene modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getSceneFormForUpdate | ||
Description |
Gets the scene form for updating an existing scene. A new scene form should be requested for each update transaction. | ||
Parameters | osid.id.Id | sceneId | the Id of the Scene |
Return | osid.control.SceneForm | the scene form | |
Errors | NOT_FOUND | sceneId is not found | |
NULL_ARGUMENT | sceneId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateScene | ||
Description |
Updates an existing scene. | ||
Parameters | osid.control.SceneForm | sceneForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | sceneForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | sceneForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | sceneForm did not originate from
getSceneFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteScenes | ||
Description |
Tests if this user can delete scenes. A return of true
does not guarantee successful authorization. A return of
false indicates that it is known deleting a | ||
Return | boolean | false if Scene deletion is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteScene | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | sceneId | the Id of the Scene to remove |
Errors | NOT_FOUND | sceneId not found | |
NULL_ARGUMENT | sceneId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageSceneAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Scene aliasing is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasScene | ||
Description |
Adds an | ||
Parameters | osid.id.Id | sceneId | the Id of a Scene |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | sceneId not found | ||
NULL_ARGUMENT | sceneId or aliasId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |