Interface OfferingBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OfferingAdminSession, OsidSession, OsidSession
public interface OfferingBatchAdminSession extends OfferingAdminSession

This session creates, updates, and deletes Offerings 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 an Offering , an OfferingForm is requested using getOfferingFormsForCreate() specifying the desired canonical unit, time period, and record Types or none if no record Types are needed. Each of the returned OfferingForms 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 an OfferingForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each OfferingForm corresponds to an attempted transaction.

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

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

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

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

The delete operations delete Offerings in bulk. To unmap an Offering from the current Catalogue , the OfferingCatalogueAssignmentSession should be used. These delete operations attempt to remove the Offering itself thus removing it from all known Catalogue catalogs. Bulk delete operations return the results in DeleteResponses .