Interface GradeEntryBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, GradeEntryAdminSession, OsidSession, OsidSession
public interface GradeEntryBatchAdminSession extends GradeEntryAdminSession

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

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

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

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

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

The delete operations delete GradeEntries in bulk. To unmap a GradeEntry from the current Gradebook , the GradeEntryGradebookAssignmentSession should be used. These delete operations attempt to remove the GradeEntry itself thus removing it from all known Gradebook catalogs. Bulk delete operations return the results in DeleteResponses .