Interface ObjectiveBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, ObjectiveAdminSession, OsidSession, OsidSession
public interface ObjectiveBatchAdminSession extends ObjectiveAdminSession

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

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

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

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

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

The delete operations delete Objectives in bulk. To unmap an Objective from the current ObjectiveBank , the ObjectiveObjectiveBankAssignmentSession should be used. These delete operations attempt to remove the Objective itself thus removing it from all known ObjectiveBank catalogs. Bulk delete operations return the results in DeleteResponses .