Interface CompositionBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, CompositionAdminSession, OsidSession, OsidSession
public interface CompositionBatchAdminSession extends CompositionAdminSession

This session creates, updates, and deletes Compositions 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 Composition , a CompositionForm is requested using getCompositionFormsForCreate() specifying the desired record Types or none if no record Types are needed. Each of the returned CompositionForms 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 CompositionForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each CompositionForm corresponds to an attempted transaction.

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

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

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

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

The delete operations delete Compositions in bulk. To unmap a Composition from the current Repository , the CompositionRepositoryAssignmentSession should be used. These delete operations attempt to remove the Composition itself thus removing it from all known Repository catalogs. Bulk delete operations return the results in DeleteResponses .