Interface ConferralBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, ConferralAdminSession, OsidSession, OsidSession
public interface ConferralBatchAdminSession extends ConferralAdminSession

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

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

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

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

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

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