Interface BankBatchAdminSession

All Superinterfaces:
AutoCloseable, BankAdminSession, Closeable, OsidSession, OsidSession
public interface BankBatchAdminSession extends BankAdminSession

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

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

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

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

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

The delete operations delete Banks in bulk. Bulk delete operations return the results in DeleteResponses .