Interface ObstacleBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, ObstacleAdminSession, OsidSession, OsidSession
public interface ObstacleBatchAdminSession extends ObstacleAdminSession

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

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

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

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

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

The delete operations delete Obstacles in bulk. To unmap an Obstacle from the current Map , the ObstacleMapAssignmentSession should be used. These delete operations attempt to remove the Obstacle itself thus removing it from all known Map catalogs. Bulk delete operations return the results in DeleteResponses .