Interface PayerBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, PayerAdminSession
public interface PayerBatchAdminSession extends PayerAdminSession

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

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

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

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

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

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