Interface | osid.billing.payment.BillingPaymentProxyManager | ||
---|---|---|---|
Implements | osid.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
| ||
Method | getPayerLookupSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.billing.payment.PayerLookupSession | a PayerLookupSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPayerLookup() is false | ||
Compliance | optional | This method must be implemented if supportsPayerLookup() is
true. | |
Method | getPayerLookupSessionForBusiness | ||
Description |
Gets the | ||
Parameters | osid.id.Id | businessId | the Id of the business |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.billing.payment.PayerLookupSession | a PayerLookupSession | |
Errors | NOT_FOUND | no Business found by the given Id | |
NULL_ARGUMENT | proxy or businessId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPayerLookup() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsPayerLookup() and
supportsVisibleFederation() are true | |
Method | getPayerQuerySession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.billing.payment.PayerQuerySession | a PayerQuerySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPayerQuery() is false | ||
Compliance | optional | This method must be implemented if supportsPayerQuery() is
true. | |
Method | getPayerQuerySessionForBusiness | ||
Description |
Gets the | ||
Parameters | osid.id.Id | businessId | the Id of the Business |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.billing.payment.PayerQuerySession | a PayerQuerySession | |
Errors | NOT_FOUND | no business found by the given Id | |
NULL_ARGUMENT | proxy or businessId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPayerQuery() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsPayerQuery() and
supportsVisibleFederation() are true | |
Method | getPayerSearchSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.billing.payment.PayerSearchSession | a PayerSearchSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPayerSearch() is false | ||
Compliance | optional | This method must be implemented if supportsPayerSearch() is
true. | |
Method | getPayerSearchSessionForBusiness | ||
Description |
Gets the | ||
Parameters | osid.id.Id | businessId | the Id of the Business |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.billing.payment.PayerSearchSession | a PayerSearchSession | |
Errors | NOT_FOUND | no business found by the given Id | |
NULL_ARGUMENT | proxy or businessId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPayerSearch() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsPayerSearch() and
supportsVisibleFederation() are true | |
Method | getPayerAdminSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.billing.payment.PayerAdminSession | a PayerAdminSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPayerAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsPayerAdmin() is
true. | |
Method | getPayerAdminSessionForBusiness | ||
Description |
Gets the | ||
Parameters | osid.id.Id | businessId | the Id of the Business |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.billing.payment.PayerAdminSession | a PayerAdminSession | |
Errors | NOT_FOUND | no business found by the given Id | |
NULL_ARGUMENT | proxy or businessId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPayerAdmin() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsPayerAdmin() and
supportsVisibleFederation() are true | |
Method | getPayerNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.billing.payment.PayerReceiver | payerReceiver | the notification callback |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.billing.payment.PayerNotificationSession | a PayerNotificationSession | |
Errors | NULL_ARGUMENT | payerReceiver or proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPayerNotification() is false | ||
Compliance | optional | This method must be implemented if supportsPayerNotification()
is true. | |
Method | getPayerNotificationSessionForBusiness | ||
Description |
Gets the | ||
Parameters | osid.billing.payment.PayerReceiver | payerReceiver | the notification callback |
osid.id.Id | businessId | the Id of the Business | |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.billing.payment.PayerNotificationSession | a PayerNotificationSession | |
Errors | NOT_FOUND | no business found by the given Id | |
NULL_ARGUMENT | payerReceiver, businessId or proxy is
null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPayerNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsPayerNotification()
and supportsVisibleFederation() are true | |
Method | getPayerBusinessSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.billing.payment.PayerBusinessSession | a PayerBusinessSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPayerBusiness() is false | ||
Compliance | optional | This method must be implemented if supportsPayerBusiness()
is true. | |
Method | getPayerBusinessAssignmentSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.billing.payment.PayerBusinessAssignmentSession | a PayerBusinessAssignmentSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPayerBusinessAssignment() is false | ||
Compliance | optional | This method must be implemented if supportsPayerBusinessAssignment()
is true. | |
Method | getPayerSmartBusinessSession | ||
Description |
Gets the | ||
Parameters | osid.id.Id | businessId | the Id of the Business |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.billing.payment.PayerSmartBusinessSession | a PayerSmartBusinessSession | |
Errors | NOT_FOUND | no business found by the given Id | |
NULL_ARGUMENT | businessId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPayerSmartBusiness() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsPayerSmartBusiness()
and supportsVisibleFederation() are true | |
Method | getPaymentLookupSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.billing.payment.PaymentLookupSession | a PaymentSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPaymentLookup() is false | ||
Compliance | optional | This method must be implemented if supportsPaymentLookup()
is true. | |
Method | getPaymentLookupSessionForBusiness | ||
Description |
Gets the | ||
Parameters | osid.id.Id | businessId | the Id of the business |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.billing.payment.PaymentLookupSession | a PaymentLookupSession | |
Errors | NOT_FOUND | no Business found by the given Id | |
NULL_ARGUMENT | proxy or businessId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPaymentLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsPaymentLookup()
and supportsVisibleFederation() are true | |
Method | getPaymentQuerySession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.billing.payment.PaymentQuerySession | a PaymentQuerySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPaymentQuery() is false | ||
Compliance | optional | This method must be implemented if supportsPaymentQuery() is
true. | |
Method | getPaymentQuerySessionForBusiness | ||
Description |
Gets the | ||
Parameters | osid.id.Id | businessId | the Id of the Business |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.billing.payment.PaymentQuerySession | a PaymentQuerySession | |
Errors | NOT_FOUND | no business found by the given Id | |
NULL_ARGUMENT | proxy or businessId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPaymentQuery() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsPaymentQuery()
and supportsVisibleFederation() are true | |
Method | getPaymentSearchSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.billing.payment.PaymentSearchSession | a PaymentSearchSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPaymentSearch() is false | ||
Compliance | optional | This method must be implemented if supportsPaymentSearch()
is true. | |
Method | getPaymentSearchSessionForBusiness | ||
Description |
Gets the | ||
Parameters | osid.id.Id | businessId | the Id of the Business |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.billing.payment.PaymentSearchSession | a PaymentSearchSession | |
Errors | NOT_FOUND | no business found by the given Id | |
NULL_ARGUMENT | proxy or businessId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPaymentSearch() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsPaymentSearch()
and supportsVisibleFederation() are true | |
Method | getPaymentAdminSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.billing.payment.PaymentAdminSession | a PaymentAdminSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPaymentAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsPaymentAdmin() is
true. | |
Method | getPaymentAdminSessionForBusiness | ||
Description |
Gets the | ||
Parameters | osid.id.Id | businessId | the Id of the Business |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.billing.payment.PaymentAdminSession | a PaymentAdminSession | |
Errors | NOT_FOUND | no business found by the given Id | |
NULL_ARGUMENT | proxy or businessId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPaymentAdmin() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsPaymentAdmin()
and supportsVisibleFederation() are true | |
Method | getPaymentNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.billing.payment.PaymentReceiver | paymentReceiver | the notification callback |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.billing.payment.PaymentNotificationSession | a PaymentNotificationSession | |
Errors | NULL_ARGUMENT | paymentReceiver or proxy is null
| |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPaymentNotification() is false | ||
Compliance | optional | This method must be implemented if supportsPaymentNotification()
is true. | |
Method | getPaymentNotificationSessionForBusiness | ||
Description |
Gets the | ||
Parameters | osid.billing.payment.PaymentReceiver | paymentReceiver | the notification callback |
osid.id.Id | businessId | the Id of the Business | |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.billing.payment.PaymentNotificationSession | a PaymentNotificationSession | |
Errors | NOT_FOUND | no business found by the given Id | |
NULL_ARGUMENT | paymentReceiver, businessId or proxy is
null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPaymentNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsPaymentNotification()
and supportsVisibleFederation() are true | |
Method | getPaymentBusinessSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.billing.payment.PaymentBusinessSession | a PaymentBusinessSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPaymentBusiness() is false | ||
Compliance | optional | This method must be implemented if supportsPaymentBusiness()
is true. | |
Method | getPaymentBusinessAssignmentSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.billing.payment.PaymentBusinessAssignmentSession | a PaymentBusinessAssignmentSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPaymentBusinessAssignment() is false | ||
Compliance | optional | This method must be implemented if
supportsPaymentBusinessAssignment() is true. | |
Method | getPaymentSmartBusinessSession | ||
Description |
Gets the | ||
Parameters | osid.id.Id | businessId | the Id of the Business |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.billing.payment.PaymentSmartBusinessSession | a PaymentSmartBusinessSession | |
Errors | NOT_FOUND | no business found by the given Id | |
NULL_ARGUMENT | businessId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPaymentSmartBusiness() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsPaymentSmartBusiness()
and supportsVisibleFederation() are true | |
Method | getSummarySession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.billing.payment.SummarySession | a SummarySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsSummary() is false | ||
Compliance | optional | This method must be implemented if supportsSummary() is
true. | |
Method | getSummarySessionForBusiness | ||
Description |
Gets the | ||
Parameters | osid.id.Id | businessId | the Id of the Business |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.billing.payment.SummarySession | a SummarySession | |
Errors | NOT_FOUND | no business found by the given Id | |
NULL_ARGUMENT | businessId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsSummary() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsSummary() and
supportsVisibleFederation() are true | |
Method | getBillingPaymentBatchProxyManager | ||
Description |
Gets a | ||
Return | osid.billing.payment.batch.BillingPaymentBatchProxyManager | a BillingPaymentBatchProxyManager | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsBillingPaymentBatch() is false | ||
Compliance | optional | This method must be implemented if supportsBillingPaymentBatch()
is true. |