Interface PoolBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, PoolAdminSession
public interface PoolBatchAdminSession extends PoolAdminSession

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

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

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

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

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

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