Interface CreditBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, CreditAdminSession, OsidSession, OsidSession
public interface CreditBatchAdminSession extends CreditAdminSession

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

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

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

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

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

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