Interface MapBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, MapAdminSession, OsidSession, OsidSession
public interface MapBatchAdminSession extends MapAdminSession

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

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

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

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

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

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