Interface CustomerBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, CustomerAdminSession, OsidSession, OsidSession
public interface CustomerBatchAdminSession extends CustomerAdminSession

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

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

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

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

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

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