Interface RenovationBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, RenovationAdminSession
public interface RenovationBatchAdminSession extends RenovationAdminSession

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

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

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

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

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

The delete operations delete Renovations in bulk. To unmap a Renovation from the current Campus , the RenovationCampusAssignmentSession should be used. These delete operations attempt to remove the Renovation itself thus removing it from all known Campus catalogs. Bulk delete operations return the results in DeleteResponses .