Interface ResponseBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, ResponseAdminSession
public interface ResponseBatchAdminSession extends ResponseAdminSession

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

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

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

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

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

The delete operations delete Responses in bulk. To unmap a Response from the current Inquiry , the ResponseInquiryAssignmentSession should be used. These delete operations attempt to remove the Response itself thus removing it from all known Inquiry catalogs. Bulk delete operations return the results in DeleteResponses .