Interface BillingBatchAdminSession

All Superinterfaces:
AutoCloseable, BillingAdminSession, Closeable, OsidSession, OsidSession
public interface BillingBatchAdminSession extends BillingAdminSession

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

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

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

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

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

The delete operations delete Billings in bulk. Bulk delete operations return the results in DeleteResponses .