Interface BranchBatchAdminSession

All Superinterfaces:
AutoCloseable, BranchAdminSession, Closeable, OsidSession, OsidSession
public interface BranchBatchAdminSession extends BranchAdminSession

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

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

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

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

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

The delete operations delete Branches in bulk. To unmap a Branch from the current Journal , the BranchJournalAssignmentSession should be used. These delete operations attempt to remove the Branch itself thus removing it from all known Journal catalogs. Bulk delete operations return the results in DeleteResponses .