Interface ConvocationBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, ConvocationAdminSession, OsidSession, OsidSession
public interface ConvocationBatchAdminSession extends ConvocationAdminSession

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

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

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

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

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

The delete operations delete Convocations in bulk. To unmap a Convocation from the current Academy , the ConvocationAcademyAssignmentSession should be used. These delete operations attempt to remove the Convocation itself thus removing it from all known Academy catalogs. Bulk delete operations return the results in DeleteResponses .