public interface BillingPaymentProxyManager extends OsidProxyManager, BillingPaymentProfile
The payer manager provides access to payer management sessions and
provides interoperability tests for various aspects of this service.
Methods in this manager support the passing of a Proxy
for
the purposes of passing information within a server application
environment. The sessions included in this manager are:
PayerLookupSession:
a session to retrieve payers
PayerQuerySession:
a session to query payers PayerSearchSession:
a session to search for payers
PayerAdminSession:
a session to create and delete
payers PayerNotificationSession:
a session to receive
notifications pertaining to payer changes PayerBusinessSession:
a session to look up payer
to business mappings PayerBusinessAssignmentSession:
a session to
manage payer to business mappings PayerSmartBusinessSession:
a session to manage
dynamic businesses of payers PaymentLookupSession:
a session to retrieve
payments PaymentQuerySession:
a session to query payments
PaymentSearchSession:
a session to search for
payments PaymentAdminSession:
a session to create and
delete payments PaymentNotificationSession:
a session to receive
notifications pertaining to payment changes PaymentBusinessSession:
a session to look up
payment to business mappings PaymentBusinessAssignmentSession:
a session to
manage payment to business mappings PaymentSmartBusinessSession:
a session to manage
dynamic businesses of payments Modifier and Type | Method and Description |
---|---|
BillingPaymentBatchProxyManager |
getBillingPaymentBatchProxyManager()
Gets a
BillingPaymentBatchProxyManager. |
PayerAdminSession |
getPayerAdminSession(Proxy proxy)
Gets the
OsidSession associated with the payer
administration service. |
PayerAdminSession |
getPayerAdminSessionForBusiness(Id businessId,
Proxy proxy)
Gets the
OsidSession associated with the payer
administration service for the given business. |
PayerBusinessAssignmentSession |
getPayerBusinessAssignmentSession(Proxy proxy)
Gets the
OsidSession associated with assigning payers
to businesses. |
PayerBusinessSession |
getPayerBusinessSession(Proxy proxy)
Gets the
OsidSession to lookup payer/catalog mappings. |
PayerLookupSession |
getPayerLookupSession(Proxy proxy)
Gets the
OsidSession associated with the payer lookup
service. |
PayerLookupSession |
getPayerLookupSessionForBusiness(Id businessId,
Proxy proxy)
Gets the
OsidSession associated with the payer lookup
service for the given business. |
PayerNotificationSession |
getPayerNotificationSession(PayerReceiver payerReceiver,
Proxy proxy)
Gets the
OsidSession associated with the payer
notification service. |
PayerNotificationSession |
getPayerNotificationSessionForBusiness(PayerReceiver payerReceiver,
Id businessId,
Proxy proxy)
Gets the
OsidSession associated with the payer
notification service for the given business. |
PayerQuerySession |
getPayerQuerySession(Proxy proxy)
Gets the
OsidSession associated with the payer query
service. |
PayerQuerySession |
getPayerQuerySessionForBusiness(Id businessId,
Proxy proxy)
Gets the
OsidSession associated with the payer query
service for the given business. |
PayerSearchSession |
getPayerSearchSession(Proxy proxy)
Gets the
OsidSession associated with the payer search
service. |
PayerSearchSession |
getPayerSearchSessionForBusiness(Id businessId,
Proxy proxy)
Gets the
OsidSession associated with the payer search
service for the given business. |
PayerSmartBusinessSession |
getPayerSmartBusinessSession(Id businessId,
Proxy proxy)
Gets the
OsidSession associated with the payer smart
business service. |
PaymentAdminSession |
getPaymentAdminSession(Proxy proxy)
Gets the
OsidSession associated with the payment
administration service. |
PaymentAdminSession |
getPaymentAdminSessionForBusiness(Id businessId,
Proxy proxy)
Gets the
OsidSession associated with the payment
administration service for the given business. |
PaymentBusinessAssignmentSession |
getPaymentBusinessAssignmentSession(Proxy proxy)
Gets the
OsidSession associated with assigning payments
to businesses. |
PaymentBusinessSession |
getPaymentBusinessSession(Proxy proxy)
Gets the
OsidSession to lookup payment/catalog
mappings. |
PaymentLookupSession |
getPaymentLookupSession(Proxy proxy)
Gets the
OsidSession associated with the payment lookup
service. |
PaymentLookupSession |
getPaymentLookupSessionForBusiness(Id businessId,
Proxy proxy)
Gets the
OsidSession associated with the payment lookup
service for the given business. |
PaymentNotificationSession |
getPaymentNotificationSession(PaymentReceiver paymentReceiver,
Proxy proxy)
Gets the
OsidSession associated with the payment
notification service. |
PaymentNotificationSession |
getPaymentNotificationSessionForBusiness(PaymentReceiver paymentReceiver,
Id businessId,
Proxy proxy)
Gets the
OsidSession associated with the payment
notification service for the given business. |
PaymentQuerySession |
getPaymentQuerySession(Proxy proxy)
Gets the
OsidSession associated with the payment query
service. |
PaymentQuerySession |
getPaymentQuerySessionForBusiness(Id businessId,
Proxy proxy)
Gets the
OsidSession associated with the payment query
service for the given business. |
PaymentSearchSession |
getPaymentSearchSession(Proxy proxy)
Gets the
OsidSession associated with the payment search
service. |
PaymentSearchSession |
getPaymentSearchSessionForBusiness(Id businessId,
Proxy proxy)
Gets the
OsidSession associated with the payment search
service for the given business. |
PaymentSmartBusinessSession |
getPaymentSmartBusinessSession(Id businessId,
Proxy proxy)
Gets the
OsidSession associated with the payment smart
business service. |
SummarySession |
getSummarySession(Proxy proxy)
Gets the
OsidSession associated with the payment
summary service. |
SummarySession |
getSummarySessionForBusiness(Id businessId,
Proxy proxy)
Gets the
OsidSession associated with the summary
service for the given business. |
changeBranch, initialize, rollbackService
close
getPayerRecordTypes, getPayerSearchRecordTypes, getPaymentRecordTypes, getPaymentSearchRecordTypes, getSummaryRecordTypes, supportsBillingPaymentBatch, supportsPayerAdmin, supportsPayerBusiness, supportsPayerBusinessAssignment, supportsPayerLookup, supportsPayerNotification, supportsPayerQuery, supportsPayerRecordType, supportsPayerSearch, supportsPayerSearchRecordType, supportsPayerSmartBusiness, supportsPaymentAdmin, supportsPaymentBusiness, supportsPaymentBusinessAssignment, supportsPaymentLookup, supportsPaymentNotification, supportsPaymentQuery, supportsPaymentRecordType, supportsPaymentSearch, supportsPaymentSearchRecordType, supportsPaymentSmartBusiness, supportsSummary, supportsSummaryRecordType, supportsVisibleFederation
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
PayerLookupSession getPayerLookupSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the payer lookup
service.proxy
- proxy PayerLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPayerLookup()
is false
optional
- This method must be implemented if
supportsPayerLookup()
is true.
PayerLookupSession getPayerLookupSessionForBusiness(Id businessId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the payer lookup
service for the given business.businessId
- the Id
of the businessproxy
- proxy PayerLookupSession
NotFoundException
- no Business
found by
the given Id
NullArgumentException
- proxy
or
businessId
is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPayerLookup()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsPayerLookup()
and
supportsVisibleFederation()
are true
PayerQuerySession getPayerQuerySession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the payer query
service.proxy
- proxy PayerQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPayerQuery()
is false
optional
- This method must be implemented if
supportsPayerQuery()
is true.
PayerQuerySession getPayerQuerySessionForBusiness(Id businessId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the payer query
service for the given business.businessId
- the Id
of the Business
proxy
- proxy PayerQuerySession
NotFoundException
- no business found by the given
Id
NullArgumentException
- proxy
or
businessId
is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPayerQuery()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsPayerQuery()
and
supportsVisibleFederation()
are true
PayerSearchSession getPayerSearchSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the payer search
service.proxy
- proxy PayerSearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPayerSearch()
is false
optional
- This method must be implemented if
supportsPayerSearch()
is true.
PayerSearchSession getPayerSearchSessionForBusiness(Id businessId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the payer search
service for the given business.businessId
- the Id
of the Business
proxy
- proxy PayerSearchSession
NotFoundException
- no business found by the given
Id
NullArgumentException
- proxy
or
businessId
is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPayerSearch()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsPayerSearch()
and
supportsVisibleFederation()
are true
PayerAdminSession getPayerAdminSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the payer
administration service.proxy
- proxy PayerAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPayerAdmin()
is false
optional
- This method must be implemented if
supportsPayerAdmin()
is true.
PayerAdminSession getPayerAdminSessionForBusiness(Id businessId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the payer
administration service for the given business.businessId
- the Id
of the Business
proxy
- proxy PayerAdminSession
NotFoundException
- no business found by the given
Id
NullArgumentException
- proxy
or
businessId
is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPayerAdmin()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsPayerAdmin()
and
supportsVisibleFederation()
are true
PayerNotificationSession getPayerNotificationSession(PayerReceiver payerReceiver, Proxy proxy) throws OperationFailedException
OsidSession
associated with the payer
notification service.payerReceiver
- the notification callbackproxy
- proxy PayerNotificationSession
NullArgumentException
- payerReceiver
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPayerNotification()
is false
optional
- This method must be implemented if
supportsPayerNotification()
is true.
PayerNotificationSession getPayerNotificationSessionForBusiness(PayerReceiver payerReceiver, Id businessId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the payer
notification service for the given business.payerReceiver
- the notification callbackbusinessId
- the Id
of the Business
proxy
- proxy PayerNotificationSession
NotFoundException
- no business found by the given
Id
NullArgumentException
- payerReceiver,
businessId
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPayerNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsPayerNotification()
and
supportsVisibleFederation()
are true
PayerBusinessSession getPayerBusinessSession(Proxy proxy) throws OperationFailedException
OsidSession
to lookup payer/catalog mappings.proxy
- proxy PayerBusinessSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPayerBusiness()
is false
optional
- This method must be implemented if
supportsPayerBusiness()
is true.
PayerBusinessAssignmentSession getPayerBusinessAssignmentSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with assigning payers
to businesses.proxy
- proxy PayerBusinessAssignmentSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPayerBusinessAssignment()
is false
optional
- This method must be implemented if
supportsPayerBusinessAssignment()
is true.
PayerSmartBusinessSession getPayerSmartBusinessSession(Id businessId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the payer smart
business service.businessId
- the Id
of the Business
proxy
- proxy PayerSmartBusinessSession
NotFoundException
- no business found by the given
Id
NullArgumentException
- businessId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPayerSmartBusiness()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsPayerSmartBusiness()
and
supportsVisibleFederation()
are true
PaymentLookupSession getPaymentLookupSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the payment lookup
service.proxy
- proxy PaymentSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPaymentLookup()
is false
optional
- This method must be implemented if
supportsPaymentLookup()
is true.
PaymentLookupSession getPaymentLookupSessionForBusiness(Id businessId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the payment lookup
service for the given business.businessId
- the Id
of the businessproxy
- proxy PaymentLookupSession
NotFoundException
- no Business
found by
the given Id
NullArgumentException
- proxy
or
businessId
is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPaymentLookup()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsPaymentLookup()
and
supportsVisibleFederation()
are true
PaymentQuerySession getPaymentQuerySession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the payment query
service.proxy
- proxy PaymentQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPaymentQuery()
is false
optional
- This method must be implemented if
supportsPaymentQuery()
is true.
PaymentQuerySession getPaymentQuerySessionForBusiness(Id businessId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the payment query
service for the given business.businessId
- the Id
of the Business
proxy
- proxy PaymentQuerySession
NotFoundException
- no business found by the given
Id
NullArgumentException
- proxy
or
businessId
is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPaymentQuery()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsPaymentQuery()
and
supportsVisibleFederation()
are true
PaymentSearchSession getPaymentSearchSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the payment search
service.proxy
- proxy PaymentSearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPaymentSearch()
is false
optional
- This method must be implemented if
supportsPaymentSearch()
is true.
PaymentSearchSession getPaymentSearchSessionForBusiness(Id businessId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the payment search
service for the given business.businessId
- the Id
of the Business
proxy
- proxy PaymentSearchSession
NotFoundException
- no business found by the given
Id
NullArgumentException
- proxy
or
businessId
is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPaymentSearch()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsPaymentSearch()
and
supportsVisibleFederation()
are true
PaymentAdminSession getPaymentAdminSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the payment
administration service.proxy
- proxy PaymentAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPaymentAdmin()
is false
optional
- This method must be implemented if
supportsPaymentAdmin()
is true.
PaymentAdminSession getPaymentAdminSessionForBusiness(Id businessId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the payment
administration service for the given business.businessId
- the Id
of the Business
proxy
- proxy PaymentAdminSession
NotFoundException
- no business found by the given
Id
NullArgumentException
- proxy
or
businessId
is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPaymentAdmin()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsPaymentAdmin()
and
supportsVisibleFederation()
are true
PaymentNotificationSession getPaymentNotificationSession(PaymentReceiver paymentReceiver, Proxy proxy) throws OperationFailedException
OsidSession
associated with the payment
notification service.paymentReceiver
- the notification callbackproxy
- proxy PaymentNotificationSession
NullArgumentException
- paymentReceiver
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPaymentNotification()
is false
optional
- This method must be implemented if
supportsPaymentNotification()
is true.
PaymentNotificationSession getPaymentNotificationSessionForBusiness(PaymentReceiver paymentReceiver, Id businessId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the payment
notification service for the given business.paymentReceiver
- the notification callbackbusinessId
- the Id
of the Business
proxy
- proxy PaymentNotificationSession
NotFoundException
- no business found by the given
Id
NullArgumentException
- paymentReceiver,
businessId
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPaymentNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsPaymentNotification()
and
supportsVisibleFederation()
are true
PaymentBusinessSession getPaymentBusinessSession(Proxy proxy) throws OperationFailedException
OsidSession
to lookup payment/catalog
mappings.proxy
- proxy PaymentBusinessSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPaymentBusiness()
is false
optional
- This method must be implemented if
supportsPaymentBusiness()
is true.
PaymentBusinessAssignmentSession getPaymentBusinessAssignmentSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with assigning payments
to businesses.proxy
- proxy PaymentBusinessAssignmentSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPaymentBusinessAssignment()
is false
optional
- This method must be implemented if
supportsPaymentBusinessAssignment()
is
true.
PaymentSmartBusinessSession getPaymentSmartBusinessSession(Id businessId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the payment smart
business service.businessId
- the Id
of the Business
proxy
- proxy PaymentSmartBusinessSession
NotFoundException
- no business found by the given
Id
NullArgumentException
- businessId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPaymentSmartBusiness()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsPaymentSmartBusiness()
and
supportsVisibleFederation()
are true
SummarySession getSummarySession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the payment
summary service.proxy
- proxy SummarySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsSummary()
is false
optional
- This method must be implemented if
supportsSummary()
is true.
SummarySession getSummarySessionForBusiness(Id businessId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the summary
service for the given business.businessId
- the Id
of the Business
proxy
- proxy SummarySession
NotFoundException
- no business found by the given
Id
NullArgumentException
- businessId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsSummary()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsSummary()
and
supportsVisibleFederation()
are true
BillingPaymentBatchProxyManager getBillingPaymentBatchProxyManager() throws OperationFailedException
BillingPaymentBatchProxyManager.
BillingPaymentBatchProxyManager
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBillingPaymentBatch()
is false
optional
- This method must be implemented if
supportsBillingPaymentBatch()
is true.