Interface GradeSystemBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, GradeSystemAdminSession, OsidSession, OsidSession
public interface GradeSystemBatchAdminSession extends GradeSystemAdminSession

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

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

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

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

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

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