Interface PaymentNotificationSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
public interface PaymentNotificationSession extends OsidSession

This session defines methods to receive notifications on adds/changes to Payments 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 .

  • Method Details

    • getBusinessId

      Id getBusinessId()
      Gets the Business Id associated with this session.
      Returns:
      the Business Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getBusiness

      Business getBusiness() throws OperationFailedException, PermissionDeniedException
      Gets the Business associated with this session.
      Returns:
      the business
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canRegisterForPaymentNotifications

      boolean canRegisterForPaymentNotifications()
      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.
      Returns:
      false if notification methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useFederatedBusinessView

      void useFederatedBusinessView()
      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.

    • useIsolatedBusinessView

      void useIsolatedBusinessView()
      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.

    • reliablePaymentNotifications

      void reliablePaymentNotifications()
      Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using acknowledgePaymentNotification() .
      Compliance:
      mandatory - This method is must be implemented.

    • unreliablePaymentNotifications

      void unreliablePaymentNotifications()
      Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
      Compliance:
      mandatory - This method is must be implemented.

    • acknowledgePaymentNotification

      void acknowledgePaymentNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
      Acknowledge a payment notification.
      Parameters:
      notificationId - the Id of the notification
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForNewPayments

      void registerForNewPayments() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new payments. PaymentReceiver.newPayments() is invoked when a new Payment appears in this business.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForNewPaymentsForPayer

      void registerForNewPaymentsForPayer(Id payerId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of new payments from the given payer. PaymentReceiver.newPayments() is invoked when a new Payment appears in this business.
      Parameters:
      payerId - the Id of the Payer to monitor
      Throws:
      NullArgumentException - payerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForNewPaymentsForCustomer

      void registerForNewPaymentsForCustomer(Id customerId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of new payments applied to the given customer. PaymentReceiver.newPayments() is invoked when a new Payment appears in this business.
      Parameters:
      customerId - the Id of the Customer to monitor
      Throws:
      NullArgumentException - customerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedPayments

      void registerForChangedPayments() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated payments. PaymentReceiver.changedPayments() is invoked when a payment in this business is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedPaymentsForPayer

      void registerForChangedPaymentsForPayer(Id payerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated payments by the given payer. PaymentReceiver.changedPayments() is invoked when the specified payment in this business is changed.
      Parameters:
      payerId - the Id of the Payer to monitor
      Throws:
      NullArgumentException - payerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedPaymentsForCustomer

      void registerForChangedPaymentsForCustomer(Id customerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated payments applied the given customer. PaymentReceiver.changedPayments() is invoked when the specified payment in this business is changed.
      Parameters:
      customerId - the Id of the Customer to monitor
      Throws:
      NullArgumentException - customerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedPayment

      void registerForChangedPayment(Id paymentId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated payment. PaymentReceiver.changedPayments() is invoked when the specified payment in this business is changed.
      Parameters:
      paymentId - the Id of the Payment to monitor
      Throws:
      NullArgumentException - paymentId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedPayments

      void registerForDeletedPayments() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted payments. PaymentReceiver.deletedPayments() is invoked when a payment is deleted or removed from this business.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedPaymentsForPayer

      void registerForDeletedPaymentsForPayer(Id payerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted payments from the given payer. PaymentReceiver.deletedPayments() is invoked when a payment is deleted or removed from this business.
      Parameters:
      payerId - the Id of the Payer to monitor
      Throws:
      NullArgumentException - payerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedPaymentsForCustomer

      void registerForDeletedPaymentsForCustomer(Id customerId) throws OperationFailedException, PermissionDeniedException
      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.
      Parameters:
      customerId - the Id of the Customer to monitor
      Throws:
      NullArgumentException - customerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedPayment

      void registerForDeletedPayment(Id paymentId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted payment. PaymentReceiver.deletedPayments() is invoked when the specified payment is deleted or removed from this business.
      Parameters:
      paymentId - the Id of the Payment to monitor
      Throws:
      NullArgumentException - paymentId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.