Interface HoldBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, HoldAdminSession, OsidSession, OsidSession
public interface HoldBatchAdminSession extends HoldAdminSession

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

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

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

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

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

The delete operations delete Holds in bulk. To unmap a Hold from the current Oubliette , the HoldOublietteAssignmentSession should be used. These delete operations attempt to remove the Hold itself thus removing it from all known Oubliette catalogs. Bulk delete operations return the results in DeleteResponses .