Interface GradeBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, GradeAdminSession, OsidSession, OsidSession
public interface GradeBatchAdminSession extends GradeAdminSession

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

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

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

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

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

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