Interface AwardEntryBatchAdminSession

All Superinterfaces:
AutoCloseable, AwardEntryAdminSession, Closeable, OsidSession, OsidSession
public interface AwardEntryBatchAdminSession extends AwardEntryAdminSession

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

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

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

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

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

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