Interface AwardBatchAdminSession

All Superinterfaces:
AutoCloseable, AwardAdminSession, Closeable, OsidSession, OsidSession
public interface AwardBatchAdminSession extends AwardAdminSession

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

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

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

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

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

The delete operations delete Awards in bulk. To unmap an Award from the current Academy , the AwardAcademyAssignmentSession should be used. These delete operations attempt to remove the Award itself thus removing it from all known Academy catalogs. Bulk delete operations return the results in DeleteResponses .