Interface StoreBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, StoreAdminSession
public interface StoreBatchAdminSession extends StoreAdminSession

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

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

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

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

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

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