Interface UtilityBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, UtilityAdminSession
public interface UtilityBatchAdminSession extends UtilityAdminSession

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

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

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

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

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

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