Interface DirectionBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, DirectionAdminSession, OsidSession, OsidSession
public interface DirectionBatchAdminSession extends DirectionAdminSession

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

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

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

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

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

The delete operations delete Directions in bulk. To unmap a Direction from the current Cookbook , the DirectionCookbookAssignmentSession should be used. These delete operations attempt to remove the Direction itself thus removing it from all known Cookbook catalogs. Bulk delete operations return the results in DeleteResponses .