OSID Logo
OSID Specifications
billing payment package
Version 3.0.0
Release Candidate Preview
Interfaceosid.billing.payment.PaymentNotificationSession
Implementsosid.OsidSession
Description

This session defines methods to receive notifications on adds/changes to Payment objects in this Business. This also includes existing payments that may appear or disappear due to changes in the Business hierarchy, This session is intended for consumers needing to synchronize their state with this service without the use of polling. Notifications are cancelled when this session is closed.

The two views defined in this session correspond to the views in the PaymentLookupSession.

MethodgetBusinessId
Description

Gets the Business Id associated with this session.

Returnosid.id.Idthe Business Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetBusiness
Description

Gets the Business associated with this session.

Returnosid.billing.Businessthe business
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanRegisterForPaymentNotifications
Description

Tests if this user can register for Payment notifications. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer notification operations.

Returnboolean false if notification methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseFederatedBusinessView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedBusinessView
Description

Isolates the view for methods in this session. An isolated view restricts notifications to this business only.

CompliancemandatoryThis method is must be implemented.
MethodreliablePaymentNotifications
Description

Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using acknowledgePaymentNotification() .

CompliancemandatoryThis method is must be implemented.
MethodunreliablePaymentNotifications
Description

Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.

CompliancemandatoryThis method is must be implemented.
MethodacknowledgePaymentNotification
Description

Acknowledge a payment notification.

Parametersosid.id.IdnotificationIdthe Id of the notification
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewPayments
Description

Register for notifications of new payments. PaymentReceiver.newPayments() is invoked when a new Payment appears in this business.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewPaymentsForPayer
Description

Register for notifications of new payments from the given payer. PaymentReceiver.newPayments() is invoked when a new Payment appears in this business.

Parametersosid.id.IdpayerIdthe Id of the Payer to monitor
ErrorsNULL_ARGUMENT payerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewPaymentsForCustomer
Description

Register for notifications of new payments applied to the given customer. PaymentReceiver.newPayments() is invoked when a new Payment appears in this business.

Parametersosid.id.IdcustomerIdthe Id of the Customer to monitor
ErrorsNULL_ARGUMENT customerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedPayments
Description

Registers for notification of updated payments. PaymentReceiver.changedPayments() is invoked when a payment in this business is changed.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedPaymentsForPayer
Description

Registers for notification of updated payments by the given payer. PaymentReceiver.changedPayments() is invoked when the specified payment in this business is changed.

Parametersosid.id.IdpayerIdthe Id of the Payer to monitor
ErrorsNULL_ARGUMENT payerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedPaymentsForCustomer
Description

Registers for notification of updated payments applied the given customer. PaymentReceiver.changedPayments() is invoked when the specified payment in this business is changed.

Parametersosid.id.IdcustomerIdthe Id of the Customer to monitor
ErrorsNULL_ARGUMENT customerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedPayment
Description

Registers for notification of an updated payment. PaymentReceiver.changedPayments() is invoked when the specified payment in this business is changed.

Parametersosid.id.IdpaymentIdthe Id of the Payment to monitor
ErrorsNULL_ARGUMENT paymentId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedPayments
Description

Registers for notification of deleted payments. PaymentReceiver.deletedPayments() is invoked when a payment is deleted or removed from this business.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedPaymentsForPayer
Description

Registers for notification of deleted payments from the given payer. PaymentReceiver.deletedPayments() is invoked when a payment is deleted or removed from this business.

Parametersosid.id.IdpayerIdthe Id of the Payer to monitor
ErrorsNULL_ARGUMENT payerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedPaymentsForCustomer
Description

Registers for notification of deleted payments applied to the given customer. PaymentReceiver.deletedPayments() is invoked when a payment is deleted or removed from this business.

Parametersosid.id.IdcustomerIdthe Id of the Customer to monitor
ErrorsNULL_ARGUMENT customerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedPayment
Description

Registers for notification of a deleted payment. PaymentReceiver.deletedPayments() is invoked when the specified payment is deleted or removed from this business.

Parametersosid.id.IdpaymentIdthe Id of the Payment to monitor
ErrorsNULL_ARGUMENT paymentId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.