Interface ProvisionableBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, ProvisionableAdminSession
public interface ProvisionableBatchAdminSession extends ProvisionableAdminSession

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

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

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

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

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

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