Interface PayerNotificationSession

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

This session defines methods to receive notifications on adds/changes to Payers in this Business . This also includes existing payers 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 PayerLookupSession .

  • 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.

    • canRegisterForPayerNotifications

      boolean canRegisterForPayerNotifications()
      Tests if this user can register for Payer 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 payers 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.

    • reliablePayerNotifications

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

    • unreliablePayerNotifications

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

    • acknowledgePayerNotification

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

    • registerForNewPayers

      void registerForNewPayers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new payers. PayerReceiver.newPayers() is invoked when a new Payer appears in this business.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForNewPayersForResource

      void registerForNewPayersForResource(Id resourceId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of new payers for the given resource. PayerReceiver.newPayers() is invoked when a new Payer appears in this business.
      Parameters:
      resourceId - the Id of the Resource to monitor
      Throws:
      NullArgumentException - resourceId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedPayers

      void registerForChangedPayers() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated payers. PayerReceiver.changedPayers() is invoked when a payer in this business is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedPayersForResource

      void registerForChangedPayersForResource(Id resourceId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated payers for the given resource. PayerReceiver.changedPayers() is invoked when the specified payer in this business is changed.
      Parameters:
      resourceId - the Id of the Resource to monitor
      Throws:
      NullArgumentException - resourceId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedPayer

      void registerForChangedPayer(Id payerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated payer. PayerReceiver.changedPayers() is invoked when the specified payer 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.

    • registerForDeletedPayers

      void registerForDeletedPayers() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted payers. PayerReceiver.deletedPayers() is invoked when a payer is deleted or removed from this business.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedPayersForResource

      void registerForDeletedPayersForResource(Id resourceId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted payers by the given resource. PayerReceiver.deletedPayers() is invoked when the specified payer is deleted or removed from this business.
      Parameters:
      resourceId - the Id of the Resource to monitor
      Throws:
      NullArgumentException - resourceId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedPayer

      void registerForDeletedPayer(Id payerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted payer. PayerReceiver.deletedPayers() is invoked when the specified payer 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.