Interface DocetBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, DocetAdminSession, OsidSession, OsidSession
public interface DocetBatchAdminSession extends DocetAdminSession

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

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

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

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

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

The delete operations delete Docets in bulk. To unmap an Docet from the current CourseCatalog , the DocetCourseCatalogAssignmentSession should be used. These delete operations attempt to remove the Docet itself thus removing it from all known CourseCatalog catalogs. Bulk delete operations return the results in DeleteResponses .