Interface ProvisionBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, ProvisionAdminSession
public interface ProvisionBatchAdminSession extends ProvisionAdminSession

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

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

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

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

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

The delete operations delete Provisions in bulk. To unmap a Provision from the current Distributor , the ProvisionDistributorAssignmentSession should be used. These delete operations attempt to remove the Provision itself thus removing it from all known Distributor catalogs. Bulk delete operations return the results in DeleteResponses .