OSID Logo
OSID Specifications
control batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.control.batch.SceneBatchAdminSession
Implementsosid.control.SceneAdminSession
Description

This session creates, updates, and deletes Scenes in bulk. The data for create and update is provided by the consumer via the form object. OsidForms are requested for each create or update and may not be reused.

Create and update operations differ in their usage. To create a Scene, a SceneForm is requested using getSceneFormsForCreate() specifying the desired record Types or none if no record Types are needed. Each of the returned SceneForms will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once a SceneForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each SceneForm corresponds to an attempted transaction.

The SceneForms returned from getSceneFormsForCreate() may be linked to the originating request through the peer Ids of the SceneForm. In the case where there may be duplicates, any SceneForm of the same peer Ids may be used for a create operation.

Once a batch of SceneForm are submitted for create, a CreateScene is returned for each SceneForm, although the ordering is not defined. Only errors that pertain to the entire create operation are returned from createScenes(), errors specific to an individual SceneForm are indicated in the corresponding CreateScene. CreateScenes may be linked to the originating SceneForm through the SceneForm Id .

For updates, SceneForms are requested to the Scene Id that is to be updated using getSceneFormsForUpdate() where the reference Id in the SceneForm may be used to link the request. Similarly, the SceneForm has metadata about the data that can be updated and it can perform validation before submitting the update. The SceneForm can only be used once for a successful update and cannot be reused.

Once a batch of SceneForms are submitted for update, an UpdateScene is returned for each SceneForm, although the ordering is not defined. Only errors that pertain to the entire update operation are returned from updateScenes(), errors specific to an individual SceneForm are indicated in the corresponding UpdateScene. UpdateScenes may be linked to the originating SceneForm through the SceneForm Id.

The delete operations delete Scenes in bulk. To unmap a Scene from the current System, the SceneSystemAssignmentSession should be used. These delete operations attempt to remove the Scene itself thus removing it from all known System catalogs. Bulk delete operations return the results in DeleteScenes.

MethodgetSceneFormsForCreate
Description

Gets the scene forms for creating a bunch of new scenes.

Parameterscardinalnthe number of forms to retrieve
osid.type.Type[]sceneRecordTypesarray of scene record types to be included in each create operation or an empty list if none
Returnosid.control.batch.SceneBatchFormListthe scene forms
ErrorsNULL_ARGUMENT peers or sceneRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateScenes
Description

Creates a new set of Scenes. This method returns an error if the entire operation fails. Otherwise, the status of an individual create operation is indicated in the BatchCreateScene .

Parametersosid.control.batch.SceneBatchFormListsceneFormsthe scene forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT sceneForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSceneFormsForUpdate
Description

Gets the scene forms for updating an existing set of scenes. A new scene form should be requested for each update transaction.

Parametersosid.id.IdListsceneIdsthe Ids of the Scene
Returnosid.control.batch.SceneBatchFormListthe scene form
ErrorsNOT_FOUNDa sceneId is not found
NULL_ARGUMENT sceneIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateScenes
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 BatchCreateScene .

Parametersosid.control.batch.SceneBatchFormListsceneFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT sceneForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllScenes
Description

Deletes all Scenes in this System.

Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteScenes
Description

Deletes scenes for the given Ids.

Parametersosid.id.IdListsceneIdsthe Ids of the scenes to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT sceneIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasScenes
Description

Adds an Id to a Scene for the purpose of creating compatibility. The primary Id of the Scene is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another scene, it is reassigned to the given scene Id.

Parametersosid.transaction.batch.AliasRequestListaliasRequeststhe alias requests
Returnosid.transaction.batch.AliasResponseListthe alias responses
ErrorsNULL_ARGUMENT aliasRequests is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.