Interface GradebookColumnBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, GradebookColumnAdminSession, OsidSession, OsidSession
public interface GradebookColumnBatchAdminSession extends GradebookColumnAdminSession

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

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

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

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

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

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