Interface AcademyBatchAdminSession

All Superinterfaces:
AcademyAdminSession, AutoCloseable, Closeable, OsidSession, OsidSession
public interface AcademyBatchAdminSession extends AcademyAdminSession

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

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

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

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

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

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