Interface | osid.billing.payment.PaymentNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive notifications on
adds/changes to The two views defined in this session correspond to the
views in the | ||
Method | getBusinessId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Business Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getBusiness | ||
Description |
Gets the | ||
Return | osid.billing.Business | the business | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canRegisterForPaymentNotifications | ||
Description |
Tests if this user can register for | ||
Return | boolean | false if notification methods are not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useFederatedBusinessView | ||
Description |
Federates the view for methods in this session. A federated view will include payments in catalogs which are children of this catalog in the business hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedBusinessView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts notifications to this business only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | reliablePaymentNotifications | ||
Description |
Reliable notifications are desired. In reliable mode,
notifications are to be acknowledged using | ||
Compliance | mandatory | This method is must be implemented. | |
Method | unreliablePaymentNotifications | ||
Description |
Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | acknowledgePaymentNotification | ||
Description |
Acknowledge a payment notification. | ||
Parameters | osid.id.Id | notificationId | the Id of the notification |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewPayments | ||
Description |
Register for notifications of new payments. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewPaymentsForPayer | ||
Description |
Register for notifications of new payments from the
given payer. | ||
Parameters | osid.id.Id | payerId | the Id of the Payer to monitor |
Errors | NULL_ARGUMENT | payerId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewPaymentsForCustomer | ||
Description |
Register for notifications of new payments applied to
the given customer. | ||
Parameters | osid.id.Id | customerId | the Id of the Customer to monitor |
Errors | NULL_ARGUMENT | customerId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedPayments | ||
Description |
Registers for notification of updated payments. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedPaymentsForPayer | ||
Description |
Registers for notification of updated payments by the
given payer. | ||
Parameters | osid.id.Id | payerId | the Id of the Payer to monitor |
Errors | NULL_ARGUMENT | payerId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedPaymentsForCustomer | ||
Description |
Registers for notification of updated payments applied
the given customer. | ||
Parameters | osid.id.Id | customerId | the Id of the Customer to monitor |
Errors | NULL_ARGUMENT | customerId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedPayment | ||
Description |
Registers for notification of an updated payment.
| ||
Parameters | osid.id.Id | paymentId | the Id of the Payment to monitor |
Errors | NULL_ARGUMENT | paymentId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedPayments | ||
Description |
Registers for notification of deleted payments. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedPaymentsForPayer | ||
Description |
Registers for notification of deleted payments from the
given payer. | ||
Parameters | osid.id.Id | payerId | the Id of the Payer to monitor |
Errors | NULL_ARGUMENT | payerId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedPaymentsForCustomer | ||
Description |
Registers for notification of deleted payments applied
to the given customer. | ||
Parameters | osid.id.Id | customerId | the Id of the Customer to monitor |
Errors | NULL_ARGUMENT | customerId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedPayment | ||
Description |
Registers for notification of a deleted payment. | ||
Parameters | osid.id.Id | paymentId | the Id of the Payment to monitor |
Errors | NULL_ARGUMENT | paymentId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |