Interface LocationBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, LocationAdminSession, OsidSession, OsidSession
public interface LocationBatchAdminSession extends LocationAdminSession

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

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

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

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

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

The delete operations delete Locations in bulk. To unmap a Location from the current Map , the LocationMapAssignmentSession should be used. These delete operations attempt to remove the Location itself thus removing it from all known Map catalogs. Bulk delete operations return the results in DeleteResponses .