Interface InquiryBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, InquiryAdminSession, OsidSession, OsidSession
public interface InquiryBatchAdminSession extends InquiryAdminSession

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

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

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

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

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

The delete operations delete Inquiries in bulk. To unmap an Inquiry from the current Inquest , the InquiryInquestAssignmentSession should be used. These delete operations attempt to remove the Inquiry itself thus removing it from all known Inquest catalogs. Bulk delete operations return the results in DeleteResponses .