Interface RegistrationTargetBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, RegistrationTargetAdminSession
public interface RegistrationTargetBatchAdminSession extends RegistrationTargetAdminSession

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

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

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

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

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

The delete operations delete RegistrationTargets in bulk. To unmap a RegistrationTarget from the current CourseCatalog , the RegistrationTargetCourseCatalogAssignmentSession should be used. These delete operations attempt to remove the RegistrationTarget itself thus removing it from all known CourseCatalog catalogs. Bulk delete operations return the results in DeleteResponses .