org.osid.billing.payment.batch

Interface PaymentBatchAdminSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession, PaymentAdminSession

public interface PaymentBatchAdminSession
extends PaymentAdminSession

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

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

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

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

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

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

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasPayments(AliasRequestList aliasRequests) Adds an Id to a Payment for the purpose of creating compatibility.
CreateResponseList	createPayments(PaymentBatchFormList paymentForms) Creates a new set of Payments.
DeleteResponseList	deleteAllPayments() Deletes all Payments in this Business .
DeleteResponseList	deletePayments(IdList paymentIds) Deletes payments for the given Ids.
DeleteResponseList	deletePaymentsForCustomer(Id customerId) Deletes payments for the given customer.
DeleteResponseList	deletePaymentsForPayer(Id payerId) Deletes payments for the given payer.
PaymentBatchFormList	getPaymentFormsForCreate(PaymentPeerList peers, Type[] paymentRecordTypes) Gets the payment forms for creating a bunch of new payments.
PaymentBatchFormList	getPaymentFormsForUpdate(IdList paymentIds) Gets the payment forms for updating an existing set of payments.
UpdateResponseList	updatePayments(PaymentBatchFormList paymentForms) Updates existing payments.

Methods inherited from interface org.osid.billing.payment.PaymentAdminSession

aliasPayment, canCreatePayments, canCreatePaymentWithRecordTypes, canDeletePayments, canManagePaymentAliases, canUpdatePayments, createPayment, deletePayment, getBusiness, getBusinessId, getPaymentFormForCreate, getPaymentFormForUpdate, updatePayment

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getPaymentFormsForCreate

PaymentBatchFormList getPaymentFormsForCreate(PaymentPeerList peers,
                                            Type[] paymentRecordTypes)
                                              throws NotFoundException,
                                                     OperationFailedException,
                                                     PermissionDeniedException

Gets the payment forms for creating a bunch of new payments. A form is returned for each set of payment peers.

Parameters:

peers - a list of payment peers

paymentRecordTypes - array of payment record types to be included in each create operation or an empty list if none

Returns:

the payment forms

Throws:

NotFoundException - a node is not found

NullArgumentException - a payerId, customerId, or paymentRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to request forms with given record types

Compliance:

mandatory - This method must be implemented.

createPayments

CreateResponseList createPayments(PaymentBatchFormList paymentForms)
                                  throws OperationFailedException,
                                         PermissionDeniedException

Creates a new set of Payments. This method returns an error if the entire operation fails. Otherwise, the status of an individual create operation is indicated in the BatchCreateResponse .

Parameters:

paymentForms - the payment forms

Returns:

the create responses

Throws:

NullArgumentException - paymentForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPaymentFormsForUpdate

PaymentBatchFormList getPaymentFormsForUpdate(IdList paymentIds)
                                              throws NotFoundException,
                                                     OperationFailedException,
                                                     PermissionDeniedException

Gets the payment forms for updating an existing set of payments. A new payment form should be requested for each update transaction.

Parameters:

paymentIds - the Ids of the Payment

Returns:

the payment form

Throws:

NotFoundException - a paymentId is not found

NullArgumentException - paymentIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updatePayments

UpdateResponseList updatePayments(PaymentBatchFormList paymentForms)
                                  throws OperationFailedException,
                                         PermissionDeniedException

Updates existing payments. This method returns an error if the entire operation fails. Otherwise, the status of an individual update operation is indicated in the BatchCreateResponse .

Parameters:

paymentForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - paymentForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllPayments

DeleteResponseList deleteAllPayments()
                                     throws OperationFailedException,
                                            PermissionDeniedException

Deletes all Payments in this Business .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deletePayments

DeleteResponseList deletePayments(IdList paymentIds)
                                  throws OperationFailedException,
                                         PermissionDeniedException

Deletes payments for the given Ids.

Parameters:

paymentIds - the Ids of the payments to delete

Returns:

the delete responses

Throws:

NullArgumentException - paymentIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deletePaymentsForPayer

DeleteResponseList deletePaymentsForPayer(Id payerId)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Deletes payments for the given payer.

Parameters:

payerId - the Id of a payer

Returns:

the delete responses

Throws:

NullArgumentException - payerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deletePaymentsForCustomer

DeleteResponseList deletePaymentsForCustomer(Id customerId)
                                             throws OperationFailedException,
                                                    PermissionDeniedException

Deletes payments for the given customer.

Parameters:

customerId - the Id of a customer

Returns:

the delete responses

Throws:

NullArgumentException - customerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasPayments

AliasResponseList aliasPayments(AliasRequestList aliasRequests)
                                throws OperationFailedException,
                                       PermissionDeniedException

Adds an Id to a Payment for the purpose of creating compatibility. The primary Id of the Payment is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another payment, it is reassigned to the given payment Id.

Parameters:

aliasRequests - the alias requests

Returns:

the alias responses

Throws:

NullArgumentException - aliasRequests is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.