Interface | osid.control.batch.SceneBatchAdminSession | ||
---|---|---|---|
Implements | osid.control.SceneAdminSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create a The Once a batch of For updates, Once a batch of The delete operations delete | ||
Method | getSceneFormsForCreate | ||
Description |
Gets the scene forms for creating a bunch of new scenes. | ||
Parameters | cardinal | n | the number of forms to retrieve |
osid.type.Type[] | sceneRecordTypes | array of scene record types to be included in each create operation or an empty list if none | |
Return | osid.control.batch.SceneBatchFormList | the scene forms | |
Errors | NULL_ARGUMENT | peers or sceneRecordTypes is null
| |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to request forms with given record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createScenes | ||
Description |
Creates a new set of | ||
Parameters | osid.control.batch.SceneBatchFormList | sceneForms | the scene forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | sceneForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSceneFormsForUpdate | ||
Description |
Gets the scene forms for updating an existing set of scenes. A new scene form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | sceneIds | the Ids of the Scene |
Return | osid.control.batch.SceneBatchFormList | the scene form | |
Errors | NOT_FOUND | a sceneId is not found | |
NULL_ARGUMENT | sceneIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateScenes | ||
Description |
Updates existing scenes. This method returns an error
if the entire operation fails. Otherwise, the status of an
individual update operation is indicated in the | ||
Parameters | osid.control.batch.SceneBatchFormList | sceneForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | sceneForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllScenes | ||
Description |
Deletes all | ||
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteScenes | ||
Description |
Deletes scenes for the given | ||
Parameters | osid.id.IdList | sceneIds | the Ids of the scenes to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | sceneIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasScenes | ||
Description |
Adds an | ||
Parameters | osid.transaction.batch.AliasRequestList | aliasRequests | the alias requests |
Return | osid.transaction.batch.AliasResponseList | the alias responses | |
Errors | NULL_ARGUMENT | aliasRequests is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |