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.
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.
|
aliasPayer, canCreatePayers, canCreatePayerWithRecordTypes, canDeletePayers, canManagePayerAliases, canUpdatePayers, createPayer, deletePayer, getBusiness, getBusinessId, getPayerFormForCreate, getPayerFormForUpdate, updatePayer
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
PayerBatchFormList getPayerFormsForCreate(IdList resourceIds, Type[] payerRecordTypes) throws NotFoundException, OperationFailedException, PermissionDeniedException
resourceIds
- a list of resourcespayerRecordTypes
- array of payer record types to be included in
each create operation or an empty list if noneNotFoundException
- a resource is not foundNullArgumentException
- resourceIds
or
payerRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createPayers(PayerBatchFormList payerForms) throws OperationFailedException, PermissionDeniedException
Payers.
This method returns an
error if the entire operation fails. Otherwise, the status of an
individual create operation is indicated in the
BatchCreateResponse
.payerForms
- the payer formsNullArgumentException
- payerForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PayerBatchFormList getPayerFormsForUpdate(IdList payerIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
payerIds
- the Ids
of the Payer
NotFoundException
- a payerId
is not
foundNullArgumentException
- payerIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updatePayers(PayerBatchFormList payerForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.payerForms
- the form containing the elements to be updatedNullArgumentException
- payerForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllPayers() throws OperationFailedException, PermissionDeniedException
Payers
in this Business
.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deletePayers(IdList payerIds) throws OperationFailedException, PermissionDeniedException
Ids.
payerIds
- the Ids
of the payers to deleteNullArgumentException
- payerIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deletePayersForResource(Id resourceId) throws OperationFailedException, PermissionDeniedException
resourceId
- the Id
of a resourceNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteIneffectivePayersByDate(DateTime date) throws OperationFailedException, PermissionDeniedException
date
- a dateNullArgumentException
- date
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasPayers(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
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.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.