Interface ObjectiveBankBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, ObjectiveBankAdminSession, OsidSession, OsidSession
public interface ObjectiveBankBatchAdminSession extends ObjectiveBankAdminSession

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

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

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

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

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

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