Interface BusinessBatchAdminSession

All Superinterfaces:
AutoCloseable, BusinessAdminSession, Closeable, OsidSession, OsidSession
public interface BusinessBatchAdminSession extends BusinessAdminSession

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

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

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

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

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

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