Interface InquestBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, InquestAdminSession, OsidSession, OsidSession
public interface InquestBatchAdminSession extends InquestAdminSession

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

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

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

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

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

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