Interface ChecklistBatchAdminSession

All Superinterfaces:
AutoCloseable, ChecklistAdminSession, Closeable, OsidSession, OsidSession
public interface ChecklistBatchAdminSession extends ChecklistAdminSession

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

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

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

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

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

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