Interface PriceScheduleBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, PriceScheduleAdminSession
public interface PriceScheduleBatchAdminSession extends PriceScheduleAdminSession

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

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

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

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

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

The delete operations delete PriceSchedules in bulk. To unmap a PriceSchedule from the current Store , the PriceScheduleStoreAssignmentSession should be used. These delete operations attempt to remove the PriceSchedule itself thus removing it from all known Store catalogs. Bulk delete operations return the results in DeleteResponses .