OSID Logo
OSID Specifications
billing payment package
Version 3.0.0
Release Candidate Preview
Interfaceosid.billing.payment.BillingPaymentProxyManager
Implementsosid.OsidProxyManager
osid.billing.payment.BillingPaymentProfile
Description

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
MethodgetPayerLookupSession
Description

Gets the OsidSession associated with the payer lookup service.

Parametersosid.proxy.Proxyproxyproxy
Returnosid.billing.payment.PayerLookupSessiona PayerLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPayerLookup() is false
ComplianceoptionalThis method must be implemented if supportsPayerLookup() is true.
MethodgetPayerLookupSessionForBusiness
Description

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

Parametersosid.id.IdbusinessIdthe Id of the business
osid.proxy.Proxyproxyproxy
Returnosid.billing.payment.PayerLookupSessiona PayerLookupSession
ErrorsNOT_FOUNDno Business found by the given Id
NULL_ARGUMENT proxy or businessId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPayerLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPayerLookup() and supportsVisibleFederation() are true
MethodgetPayerQuerySession
Description

Gets the OsidSession associated with the payer query service.

Parametersosid.proxy.Proxyproxyproxy
Returnosid.billing.payment.PayerQuerySessiona PayerQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPayerQuery() is false
ComplianceoptionalThis method must be implemented if supportsPayerQuery() is true.
MethodgetPayerQuerySessionForBusiness
Description

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

Parametersosid.id.IdbusinessIdthe Id of the Business
osid.proxy.Proxyproxyproxy
Returnosid.billing.payment.PayerQuerySessiona PayerQuerySession
ErrorsNOT_FOUNDno business found by the given Id
NULL_ARGUMENT proxy or businessId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPayerQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPayerQuery() and supportsVisibleFederation() are true
MethodgetPayerSearchSession
Description

Gets the OsidSession associated with the payer search service.

Parametersosid.proxy.Proxyproxyproxy
Returnosid.billing.payment.PayerSearchSessiona PayerSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPayerSearch() is false
ComplianceoptionalThis method must be implemented if supportsPayerSearch() is true.
MethodgetPayerSearchSessionForBusiness
Description

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

Parametersosid.id.IdbusinessIdthe Id of the Business
osid.proxy.Proxyproxyproxy
Returnosid.billing.payment.PayerSearchSessiona PayerSearchSession
ErrorsNOT_FOUNDno business found by the given Id
NULL_ARGUMENT proxy or businessId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPayerSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPayerSearch() and supportsVisibleFederation() are true
MethodgetPayerAdminSession
Description

Gets the OsidSession associated with the payer administration service.

Parametersosid.proxy.Proxyproxyproxy
Returnosid.billing.payment.PayerAdminSessiona PayerAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPayerAdmin() is false
ComplianceoptionalThis method must be implemented if supportsPayerAdmin() is true.
MethodgetPayerAdminSessionForBusiness
Description

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

Parametersosid.id.IdbusinessIdthe Id of the Business
osid.proxy.Proxyproxyproxy
Returnosid.billing.payment.PayerAdminSessiona PayerAdminSession
ErrorsNOT_FOUNDno business found by the given Id
NULL_ARGUMENT proxy or businessId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPayerAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPayerAdmin() and supportsVisibleFederation() are true
MethodgetPayerNotificationSession
Description

Gets the OsidSession associated with the payer notification service.

Parametersosid.billing.payment.PayerReceiverpayerReceiverthe notification callback
osid.proxy.Proxyproxyproxy
Returnosid.billing.payment.PayerNotificationSessiona PayerNotificationSession
ErrorsNULL_ARGUMENT payerReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPayerNotification() is false
ComplianceoptionalThis method must be implemented if supportsPayerNotification() is true.
MethodgetPayerNotificationSessionForBusiness
Description

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

Parametersosid.billing.payment.PayerReceiverpayerReceiverthe notification callback
osid.id.IdbusinessIdthe Id of the Business
osid.proxy.Proxyproxyproxy
Returnosid.billing.payment.PayerNotificationSessiona PayerNotificationSession
ErrorsNOT_FOUNDno business found by the given Id
NULL_ARGUMENT payerReceiver, businessId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPayerNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPayerNotification() and supportsVisibleFederation() are true
MethodgetPayerBusinessSession
Description

Gets the OsidSession to lookup payer/catalog mappings.

Parametersosid.proxy.Proxyproxyproxy
Returnosid.billing.payment.PayerBusinessSessiona PayerBusinessSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPayerBusiness() is false
ComplianceoptionalThis method must be implemented if supportsPayerBusiness() is true.
MethodgetPayerBusinessAssignmentSession
Description

Gets the OsidSession associated with assigning payers to businesses.

Parametersosid.proxy.Proxyproxyproxy
Returnosid.billing.payment.PayerBusinessAssignmentSessiona PayerBusinessAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPayerBusinessAssignment() is false
ComplianceoptionalThis method must be implemented if supportsPayerBusinessAssignment() is true.
MethodgetPayerSmartBusinessSession
Description

Gets the OsidSession associated with the payer smart business service.

Parametersosid.id.IdbusinessIdthe Id of the Business
osid.proxy.Proxyproxyproxy
Returnosid.billing.payment.PayerSmartBusinessSessiona PayerSmartBusinessSession
ErrorsNOT_FOUNDno business found by the given Id
NULL_ARGUMENT businessId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPayerSmartBusiness() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPayerSmartBusiness() and supportsVisibleFederation() are true
MethodgetPaymentLookupSession
Description

Gets the OsidSession associated with the payment lookup service.

Parametersosid.proxy.Proxyproxyproxy
Returnosid.billing.payment.PaymentLookupSessiona PaymentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPaymentLookup() is false
ComplianceoptionalThis method must be implemented if supportsPaymentLookup() is true.
MethodgetPaymentLookupSessionForBusiness
Description

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

Parametersosid.id.IdbusinessIdthe Id of the business
osid.proxy.Proxyproxyproxy
Returnosid.billing.payment.PaymentLookupSessiona PaymentLookupSession
ErrorsNOT_FOUNDno Business found by the given Id
NULL_ARGUMENT proxy or businessId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPaymentLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPaymentLookup() and supportsVisibleFederation() are true
MethodgetPaymentQuerySession
Description

Gets the OsidSession associated with the payment query service.

Parametersosid.proxy.Proxyproxyproxy
Returnosid.billing.payment.PaymentQuerySessiona PaymentQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPaymentQuery() is false
ComplianceoptionalThis method must be implemented if supportsPaymentQuery() is true.
MethodgetPaymentQuerySessionForBusiness
Description

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

Parametersosid.id.IdbusinessIdthe Id of the Business
osid.proxy.Proxyproxyproxy
Returnosid.billing.payment.PaymentQuerySessiona PaymentQuerySession
ErrorsNOT_FOUNDno business found by the given Id
NULL_ARGUMENT proxy or businessId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPaymentQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPaymentQuery() and supportsVisibleFederation() are true
MethodgetPaymentSearchSession
Description

Gets the OsidSession associated with the payment search service.

Parametersosid.proxy.Proxyproxyproxy
Returnosid.billing.payment.PaymentSearchSessiona PaymentSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPaymentSearch() is false
ComplianceoptionalThis method must be implemented if supportsPaymentSearch() is true.
MethodgetPaymentSearchSessionForBusiness
Description

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

Parametersosid.id.IdbusinessIdthe Id of the Business
osid.proxy.Proxyproxyproxy
Returnosid.billing.payment.PaymentSearchSessiona PaymentSearchSession
ErrorsNOT_FOUNDno business found by the given Id
NULL_ARGUMENT proxy or businessId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPaymentSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPaymentSearch() and supportsVisibleFederation() are true
MethodgetPaymentAdminSession
Description

Gets the OsidSession associated with the payment administration service.

Parametersosid.proxy.Proxyproxyproxy
Returnosid.billing.payment.PaymentAdminSessiona PaymentAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPaymentAdmin() is false
ComplianceoptionalThis method must be implemented if supportsPaymentAdmin() is true.
MethodgetPaymentAdminSessionForBusiness
Description

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

Parametersosid.id.IdbusinessIdthe Id of the Business
osid.proxy.Proxyproxyproxy
Returnosid.billing.payment.PaymentAdminSessiona PaymentAdminSession
ErrorsNOT_FOUNDno business found by the given Id
NULL_ARGUMENT proxy or businessId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPaymentAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPaymentAdmin() and supportsVisibleFederation() are true
MethodgetPaymentNotificationSession
Description

Gets the OsidSession associated with the payment notification service.

Parametersosid.billing.payment.PaymentReceiverpaymentReceiverthe notification callback
osid.proxy.Proxyproxyproxy
Returnosid.billing.payment.PaymentNotificationSessiona PaymentNotificationSession
ErrorsNULL_ARGUMENT paymentReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPaymentNotification() is false
ComplianceoptionalThis method must be implemented if supportsPaymentNotification() is true.
MethodgetPaymentNotificationSessionForBusiness
Description

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

Parametersosid.billing.payment.PaymentReceiverpaymentReceiverthe notification callback
osid.id.IdbusinessIdthe Id of the Business
osid.proxy.Proxyproxyproxy
Returnosid.billing.payment.PaymentNotificationSessiona PaymentNotificationSession
ErrorsNOT_FOUNDno business found by the given Id
NULL_ARGUMENT paymentReceiver, businessId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPaymentNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPaymentNotification() and supportsVisibleFederation() are true
MethodgetPaymentBusinessSession
Description

Gets the OsidSession to lookup payment/catalog mappings.

Parametersosid.proxy.Proxyproxyproxy
Returnosid.billing.payment.PaymentBusinessSessiona PaymentBusinessSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPaymentBusiness() is false
ComplianceoptionalThis method must be implemented if supportsPaymentBusiness() is true.
MethodgetPaymentBusinessAssignmentSession
Description

Gets the OsidSession associated with assigning payments to businesses.

Parametersosid.proxy.Proxyproxyproxy
Returnosid.billing.payment.PaymentBusinessAssignmentSessiona PaymentBusinessAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPaymentBusinessAssignment() is false
ComplianceoptionalThis method must be implemented if supportsPaymentBusinessAssignment() is true.
MethodgetPaymentSmartBusinessSession
Description

Gets the OsidSession associated with the payment smart business service.

Parametersosid.id.IdbusinessIdthe Id of the Business
osid.proxy.Proxyproxyproxy
Returnosid.billing.payment.PaymentSmartBusinessSessiona PaymentSmartBusinessSession
ErrorsNOT_FOUNDno business found by the given Id
NULL_ARGUMENT businessId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPaymentSmartBusiness() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPaymentSmartBusiness() and supportsVisibleFederation() are true
MethodgetSummarySession
Description

Gets the OsidSession associated with the payment summary service.

Parametersosid.proxy.Proxyproxyproxy
Returnosid.billing.payment.SummarySessiona SummarySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSummary() is false
ComplianceoptionalThis method must be implemented if supportsSummary() is true.
MethodgetSummarySessionForBusiness
Description

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

Parametersosid.id.IdbusinessIdthe Id of the Business
osid.proxy.Proxyproxyproxy
Returnosid.billing.payment.SummarySessiona SummarySession
ErrorsNOT_FOUNDno business found by the given Id
NULL_ARGUMENT businessId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSummary() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsSummary() and supportsVisibleFederation() are true
MethodgetBillingPaymentBatchProxyManager
Description

Gets a BillingPaymentBatchProxyManager.

Returnosid.billing.payment.batch.BillingPaymentBatchProxyManagera BillingPaymentBatchProxyManager
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsBillingPaymentBatch() is false
ComplianceoptionalThis method must be implemented if supportsBillingPaymentBatch() is true.