org.osid.billing.payment

Interface BillingPaymentProxyManager

All Superinterfaces:

java.lang.AutoCloseable, BillingPaymentProfile, java.io.Closeable, OsidProfile, OsidProxyManager, Sourceable

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
• SummarySession: a session to look up account summaries

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

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

close

Methods inherited from interface java.io.Closeable

close

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

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

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getPayerLookupSession

PayerLookupSession getPayerLookupSession(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the payer lookup service.

Parameters:

proxy - proxy

Returns:

a PayerLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPayerLookup() is false

Compliance:

optional - This method must be implemented if supportsPayerLookup() is true.

getPayerLookupSessionForBusiness

PayerLookupSession getPayerLookupSessionForBusiness(Id businessId,
                                                  Proxy proxy)
                                                    throws NotFoundException,
                                                           OperationFailedException

Gets the OsidSession associated with the payer lookup service for the given business.

Parameters:

businessId - the Id of the business

proxy - proxy

Returns:

a PayerLookupSession

Throws:

NotFoundException - no Business found by the given Id

NullArgumentException - proxy or businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPayerLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsPayerLookup() and supportsVisibleFederation() are true

getPayerQuerySession

PayerQuerySession getPayerQuerySession(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the payer query service.

Parameters:

proxy - proxy

Returns:

a PayerQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPayerQuery() is false

Compliance:

optional - This method must be implemented if supportsPayerQuery() is true.

getPayerQuerySessionForBusiness

PayerQuerySession getPayerQuerySessionForBusiness(Id businessId,
                                                Proxy proxy)
                                                  throws NotFoundException,
                                                         OperationFailedException

Gets the OsidSession associated with the payer query service for the given business.

Parameters:

businessId - the Id of the Business

proxy - proxy

Returns:

a PayerQuerySession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - proxy or businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPayerQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsPayerQuery() and supportsVisibleFederation() are true

getPayerSearchSession

PayerSearchSession getPayerSearchSession(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the payer search service.

Parameters:

proxy - proxy

Returns:

a PayerSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPayerSearch() is false

Compliance:

optional - This method must be implemented if supportsPayerSearch() is true.

getPayerSearchSessionForBusiness

PayerSearchSession getPayerSearchSessionForBusiness(Id businessId,
                                                  Proxy proxy)
                                                    throws NotFoundException,
                                                           OperationFailedException

Gets the OsidSession associated with the payer search service for the given business.

Parameters:

businessId - the Id of the Business

proxy - proxy

Returns:

a PayerSearchSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - proxy or businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPayerSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsPayerSearch() and supportsVisibleFederation() are true

getPayerAdminSession

PayerAdminSession getPayerAdminSession(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the payer administration service.

Parameters:

proxy - proxy

Returns:

a PayerAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPayerAdmin() is false

Compliance:

optional - This method must be implemented if supportsPayerAdmin() is true.

getPayerAdminSessionForBusiness

PayerAdminSession getPayerAdminSessionForBusiness(Id businessId,
                                                Proxy proxy)
                                                  throws NotFoundException,
                                                         OperationFailedException

Gets the OsidSession associated with the payer administration service for the given business.

Parameters:

businessId - the Id of the Business

proxy - proxy

Returns:

a PayerAdminSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - proxy or businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPayerAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsPayerAdmin() and supportsVisibleFederation() are true

getPayerNotificationSession

PayerNotificationSession getPayerNotificationSession(PayerReceiver payerReceiver,
                                                   Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the payer notification service.

Parameters:

payerReceiver - the notification callback

proxy - proxy

Returns:

a PayerNotificationSession

Throws:

NullArgumentException - payerReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPayerNotification() is false

Compliance:

optional - This method must be implemented if supportsPayerNotification() is true.

getPayerNotificationSessionForBusiness

PayerNotificationSession getPayerNotificationSessionForBusiness(PayerReceiver payerReceiver,
                                                              Id businessId,
                                                              Proxy proxy)
                                                                throws NotFoundException,
                                                                       OperationFailedException

Gets the OsidSession associated with the payer notification service for the given business.

Parameters:

payerReceiver - the notification callback

businessId - the Id of the Business

proxy - proxy

Returns:

a PayerNotificationSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - payerReceiver, businessId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPayerNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsPayerNotification() and supportsVisibleFederation() are true

getPayerBusinessSession

PayerBusinessSession getPayerBusinessSession(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession to lookup payer/catalog mappings.

Parameters:

proxy - proxy

Returns:

a PayerBusinessSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPayerBusiness() is false

Compliance:

optional - This method must be implemented if supportsPayerBusiness() is true.

getPayerBusinessAssignmentSession

PayerBusinessAssignmentSession getPayerBusinessAssignmentSession(Proxy proxy)
                                                                 throws OperationFailedException

Gets the OsidSession associated with assigning payers to businesses.

Parameters:

proxy - proxy

Returns:

a PayerBusinessAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPayerBusinessAssignment() is false

Compliance:

optional - This method must be implemented if supportsPayerBusinessAssignment() is true.

getPayerSmartBusinessSession

PayerSmartBusinessSession getPayerSmartBusinessSession(Id businessId,
                                                     Proxy proxy)
                                                       throws NotFoundException,
                                                              OperationFailedException

Gets the OsidSession associated with the payer smart business service.

Parameters:

businessId - the Id of the Business

proxy - proxy

Returns:

a PayerSmartBusinessSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - businessId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPayerSmartBusiness() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsPayerSmartBusiness() and supportsVisibleFederation() are true

getPaymentLookupSession

PaymentLookupSession getPaymentLookupSession(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the payment lookup service.

Parameters:

proxy - proxy

Returns:

a PaymentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPaymentLookup() is false

Compliance:

optional - This method must be implemented if supportsPaymentLookup() is true.

getPaymentLookupSessionForBusiness

PaymentLookupSession getPaymentLookupSessionForBusiness(Id businessId,
                                                      Proxy proxy)
                                                        throws NotFoundException,
                                                               OperationFailedException

Gets the OsidSession associated with the payment lookup service for the given business.

Parameters:

businessId - the Id of the business

proxy - proxy

Returns:

a PaymentLookupSession

Throws:

NotFoundException - no Business found by the given Id

NullArgumentException - proxy or businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPaymentLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsPaymentLookup() and supportsVisibleFederation() are true

getPaymentQuerySession

PaymentQuerySession getPaymentQuerySession(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession associated with the payment query service.

Parameters:

proxy - proxy

Returns:

a PaymentQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPaymentQuery() is false

Compliance:

optional - This method must be implemented if supportsPaymentQuery() is true.

getPaymentQuerySessionForBusiness

PaymentQuerySession getPaymentQuerySessionForBusiness(Id businessId,
                                                    Proxy proxy)
                                                      throws NotFoundException,
                                                             OperationFailedException

Gets the OsidSession associated with the payment query service for the given business.

Parameters:

businessId - the Id of the Business

proxy - proxy

Returns:

a PaymentQuerySession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - proxy or businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPaymentQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsPaymentQuery() and supportsVisibleFederation() are true

getPaymentSearchSession

PaymentSearchSession getPaymentSearchSession(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the payment search service.

Parameters:

proxy - proxy

Returns:

a PaymentSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPaymentSearch() is false

Compliance:

optional - This method must be implemented if supportsPaymentSearch() is true.

getPaymentSearchSessionForBusiness

PaymentSearchSession getPaymentSearchSessionForBusiness(Id businessId,
                                                      Proxy proxy)
                                                        throws NotFoundException,
                                                               OperationFailedException

Gets the OsidSession associated with the payment search service for the given business.

Parameters:

businessId - the Id of the Business

proxy - proxy

Returns:

a PaymentSearchSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - proxy or businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPaymentSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsPaymentSearch() and supportsVisibleFederation() are true

getPaymentAdminSession

PaymentAdminSession getPaymentAdminSession(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession associated with the payment administration service.

Parameters:

proxy - proxy

Returns:

a PaymentAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPaymentAdmin() is false

Compliance:

optional - This method must be implemented if supportsPaymentAdmin() is true.

getPaymentAdminSessionForBusiness

PaymentAdminSession getPaymentAdminSessionForBusiness(Id businessId,
                                                    Proxy proxy)
                                                      throws NotFoundException,
                                                             OperationFailedException

Gets the OsidSession associated with the payment administration service for the given business.

Parameters:

businessId - the Id of the Business

proxy - proxy

Returns:

a PaymentAdminSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - proxy or businessId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPaymentAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsPaymentAdmin() and supportsVisibleFederation() are true

getPaymentNotificationSession

PaymentNotificationSession getPaymentNotificationSession(PaymentReceiver paymentReceiver,
                                                       Proxy proxy)
                                                         throws OperationFailedException

Gets the OsidSession associated with the payment notification service.

Parameters:

paymentReceiver - the notification callback

proxy - proxy

Returns:

a PaymentNotificationSession

Throws:

NullArgumentException - paymentReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPaymentNotification() is false

Compliance:

optional - This method must be implemented if supportsPaymentNotification() is true.

getPaymentNotificationSessionForBusiness

PaymentNotificationSession getPaymentNotificationSessionForBusiness(PaymentReceiver paymentReceiver,
                                                                  Id businessId,
                                                                  Proxy proxy)
                                                                    throws NotFoundException,
                                                                           OperationFailedException

Gets the OsidSession associated with the payment notification service for the given business.

Parameters:

paymentReceiver - the notification callback

businessId - the Id of the Business

proxy - proxy

Returns:

a PaymentNotificationSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - paymentReceiver, businessId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPaymentNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsPaymentNotification() and supportsVisibleFederation() are true

getPaymentBusinessSession

PaymentBusinessSession getPaymentBusinessSession(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession to lookup payment/catalog mappings.

Parameters:

proxy - proxy

Returns:

a PaymentBusinessSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPaymentBusiness() is false

Compliance:

optional - This method must be implemented if supportsPaymentBusiness() is true.

getPaymentBusinessAssignmentSession

PaymentBusinessAssignmentSession getPaymentBusinessAssignmentSession(Proxy proxy)
                                                                     throws OperationFailedException

Gets the OsidSession associated with assigning payments to businesses.

Parameters:

proxy - proxy

Returns:

a PaymentBusinessAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPaymentBusinessAssignment() is false

Compliance:

optional - This method must be implemented if supportsPaymentBusinessAssignment() is true.

getPaymentSmartBusinessSession

PaymentSmartBusinessSession getPaymentSmartBusinessSession(Id businessId,
                                                         Proxy proxy)
                                                           throws NotFoundException,
                                                                  OperationFailedException

Gets the OsidSession associated with the payment smart business service.

Parameters:

businessId - the Id of the Business

proxy - proxy

Returns:

a PaymentSmartBusinessSession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - businessId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPaymentSmartBusiness() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsPaymentSmartBusiness() and supportsVisibleFederation() are true

getSummarySession

SummarySession getSummarySession(Proxy proxy)
                                 throws OperationFailedException

Gets the OsidSession associated with the payment summary service.

Parameters:

proxy - proxy

Returns:

a SummarySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSummary() is false

Compliance:

optional - This method must be implemented if supportsSummary() is true.

getSummarySessionForBusiness

SummarySession getSummarySessionForBusiness(Id businessId,
                                          Proxy proxy)
                                            throws NotFoundException,
                                                   OperationFailedException

Gets the OsidSession associated with the summary service for the given business.

Parameters:

businessId - the Id of the Business

proxy - proxy

Returns:

a SummarySession

Throws:

NotFoundException - no business found by the given Id

NullArgumentException - businessId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSummary() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsSummary() and supportsVisibleFederation() are true

getBillingPaymentBatchProxyManager

BillingPaymentBatchProxyManager getBillingPaymentBatchProxyManager()
                                                                   throws OperationFailedException

Gets a BillingPaymentBatchProxyManager.

Returns:

a BillingPaymentBatchProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBillingPaymentBatch() is false

Compliance:

optional - This method must be implemented if supportsBillingPaymentBatch() is true.