org.osid.billing.payment.batch

Interface PayerBatchAdminSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, 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.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasPayers(AliasRequestList aliasRequests) Adds an Id to a Payer for the purpose of creating compatibility.
CreateResponseList	createPayers(PayerBatchFormList payerForms) Creates a new set of Payers.
DeleteResponseList	deleteAllPayers() Deletes all Payers in this Business .
DeleteResponseList	deleteIneffectivePayersByDate(DateTime date) Deletes payers ineffective before the given date.
DeleteResponseList	deletePayers(IdList payerIds) Deletes payers for the given Ids.
DeleteResponseList	deletePayersForResource(Id resourceId) Deletes payers for the given resource.
PayerBatchFormList	getPayerFormsForCreate(IdList resourceIds, Type[] payerRecordTypes) Gets the payer forms for creating a bunch of new payers.
PayerBatchFormList	getPayerFormsForUpdate(IdList payerIds) Gets the payer forms for updating an existing set of payers.
UpdateResponseList	updatePayers(PayerBatchFormList payerForms) Updates existing payers.

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

aliasPayer, canCreatePayers, canCreatePayerWithRecordTypes, canDeletePayers, canManagePayerAliases, canUpdatePayers, createPayer, deletePayer, getBusiness, getBusinessId, getPayerFormForCreate, getPayerFormForUpdate, updatePayer

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

getPayerFormsForCreate

PayerBatchFormList getPayerFormsForCreate(IdList resourceIds,
                                        Type[] payerRecordTypes)
                                          throws NotFoundException,
                                                 OperationFailedException,
                                                 PermissionDeniedException

Gets the payer forms for creating a bunch of new payers. A form is returned for each supplied resource.

Parameters:

resourceIds - a list of resources

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

Returns:

the payer forms

Throws:

NotFoundException - a resource is not found

NullArgumentException - resourceIds or payerRecordTypes 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.

createPayers

CreateResponseList createPayers(PayerBatchFormList payerForms)
                                throws OperationFailedException,
                                       PermissionDeniedException

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

Parameters:

payerForms - the payer forms

Returns:

the create responses

Throws:

NullArgumentException - payerForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPayerFormsForUpdate

PayerBatchFormList getPayerFormsForUpdate(IdList payerIds)
                                          throws NotFoundException,
                                                 OperationFailedException,
                                                 PermissionDeniedException

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

Parameters:

payerIds - the Ids of the Payer

Returns:

the payer form

Throws:

NotFoundException - a payerId is not found

NullArgumentException - payerIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updatePayers

UpdateResponseList updatePayers(PayerBatchFormList payerForms)
                                throws OperationFailedException,
                                       PermissionDeniedException

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

Parameters:

payerForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - payerForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllPayers

DeleteResponseList deleteAllPayers()
                                   throws OperationFailedException,
                                          PermissionDeniedException

Deletes all Payers in this Business .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deletePayers

DeleteResponseList deletePayers(IdList payerIds)
                                throws OperationFailedException,
                                       PermissionDeniedException

Deletes payers for the given Ids.

Parameters:

payerIds - the Ids of the payers to delete

Returns:

the delete responses

Throws:

NullArgumentException - payerIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deletePayersForResource

DeleteResponseList deletePayersForResource(Id resourceId)
                                           throws OperationFailedException,
                                                  PermissionDeniedException

Deletes payers for the given resource.

Parameters:

resourceId - the Id of a resource

Returns:

the delete responses

Throws:

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteIneffectivePayersByDate

DeleteResponseList deleteIneffectivePayersByDate(DateTime date)
                                                 throws OperationFailedException,
                                                        PermissionDeniedException

Deletes payers ineffective before the given date.

Parameters:

date - a date

Returns:

the delete responses

Throws:

NullArgumentException - date is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasPayers

AliasResponseList aliasPayers(AliasRequestList aliasRequests)
                              throws OperationFailedException,
                                     PermissionDeniedException

Adds an Id to a Payer for the purpose of creating compatibility. The primary Id of the Payer is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another payer, it is reassigned to the given payer 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.