Interface SpeedZoneBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, SpeedZoneAdminSession
public interface SpeedZoneBatchAdminSession extends SpeedZoneAdminSession

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

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

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

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

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

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