Interface OublietteBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, OublietteAdminSession
public interface OublietteBatchAdminSession extends OublietteAdminSession

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

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

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

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

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

The delete operations delete Oubliettes in bulk. Bulk delete operations return the results in DeleteResponses .