Interface FrontOfficeBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, FrontOfficeAdminSession, OsidSession, OsidSession
public interface FrontOfficeBatchAdminSession extends FrontOfficeAdminSession

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

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

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

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

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

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