Interface PressBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, PressAdminSession
public interface PressBatchAdminSession extends PressAdminSession

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

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

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

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

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

The delete operations delete Presses in bulk. Bulk delete operations return the results in DeleteResponses .