Interface GradebookBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, GradebookAdminSession, OsidSession, OsidSession
public interface GradebookBatchAdminSession extends GradebookAdminSession

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

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

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

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

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

The delete operations delete Gradebooks in bulk. Bulk delete operations return the results in DeleteResponses .