Interface BrokerBatchAdminSession

All Superinterfaces:
AutoCloseable, BrokerAdminSession, Closeable, OsidSession, OsidSession
public interface BrokerBatchAdminSession extends BrokerAdminSession

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

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

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

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

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

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