Interface OfficeBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OfficeAdminSession, OsidSession, OsidSession
public interface OfficeBatchAdminSession extends OfficeAdminSession

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

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

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

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

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

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