Interface BillingPaymentProxyManager

All Superinterfaces:

AutoCloseable, BillingPaymentProfile, Closeable, OsidProfile, OsidProxyManager, 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

Modifier and Type	Method	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 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

Modifier and Type	Method	Description
TypeList	getPayerRecordTypes()	Gets the supported Payer record types.
TypeList	getPayerSearchRecordTypes()	Gets the supported Payer search record types.
TypeList	getPaymentRecordTypes()	Gets the supported Payment record types.
TypeList	getPaymentSearchRecordTypes()	Gets the supported Payment search record types.
TypeList	getSummaryRecordTypes()	Gets the supported Summary record types.
boolean	supportsBillingPaymentBatch()	Tests if a payment batch service is available.
boolean	supportsPayerAdmin()	Tests if payer administrative service is supported.
boolean	supportsPayerBusiness()	Tests if a businessing service is supported.
boolean	supportsPayerBusinessAssignment()	Tests if a businessing service is supported.
boolean	supportsPayerLookup()	Tests if looking up payers is supported.
boolean	supportsPayerNotification()	Tests if a payer notification service is supported.
boolean	supportsPayerQuery()	Tests if querying payers is supported.
boolean	supportsPayerRecordType(Type payerRecordType)	Tests if the given Payer record type is supported.
boolean	supportsPayerSearch()	Tests if searching payers is supported.
boolean	supportsPayerSearchRecordType(Type payerSearchRecordType)	Tests if the given Payer search record type is supported.
boolean	supportsPayerSmartBusiness()	Tests if a payer smart business session is available.
boolean	supportsPaymentAdmin()	Tests if payment administrative service is supported.
boolean	supportsPaymentBusiness()	Tests if a payment cataloging service is supported.
boolean	supportsPaymentBusinessAssignment()	Tests if a payment cataloging service is supported.
boolean	supportsPaymentLookup()	Tests if looking up payments is supported.
boolean	supportsPaymentNotification()	Tests if a payment notification service is supported.
boolean	supportsPaymentQuery()	Tests if querying payments is supported.
boolean	supportsPaymentRecordType(Type paymentRecordType)	Tests if the given Payment record type is supported.
boolean	supportsPaymentSearch()	Tests if searching payments is supported.
boolean	supportsPaymentSearchRecordType(Type paymentSearchRecordType)	Tests if the given Payment search record type is supported.
boolean	supportsPaymentSmartBusiness()	Tests if a payment smart business session is available.
boolean	supportsSummary()	Tests if a payment summary session is available.
boolean	supportsSummaryRecordType(Type summaryRecordType)	Tests if the given Summary record type is supported.
boolean	supportsVisibleFederation()	Tests if any business federation is exposed.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidProfile

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

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface OsidProxyManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidProxyManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId, Proxy proxy)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime, Proxy proxy)	Rolls back this service to a point in time.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

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 {@code supportsPayerLookup()} is {@code 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 {@code supportsPayerLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsPayerQuery()} is {@code 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 {@code supportsPayerQuery()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsPayerSearch()} is {@code 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 {@code supportsPayerSearch()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsPayerAdmin()} is {@code 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 {@code supportsPayerAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsPayerNotification()} is {@code 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 {@code supportsPayerNotification()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsPayerBusiness()} is {@code 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 {@code supportsPayerBusinessAssignment()} is {@code 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 {@code supportsPayerSmartBusiness()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsPaymentLookup()} is {@code 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 {@code supportsPaymentLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsPaymentQuery()} is {@code 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 {@code supportsPaymentQuery()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsPaymentSearch()} is {@code 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 {@code supportsPaymentSearch()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsPaymentAdmin()} is {@code 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 {@code supportsPaymentAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsPaymentNotification()} is {@code 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 {@code supportsPaymentNotification()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsPaymentBusiness()} is {@code 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 {@code supportsPaymentBusinessAssignment()} is {@code 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 {@code supportsPaymentSmartBusiness()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsSummary()} is {@code 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 {@code supportsSummary()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsBillingPaymentBatch()} is {@code true} .