Interface RequestTransactionNotificationSession

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

This session defines methods to receive notifications on adds/changes to RequestTransaction objects in this Distributor . This also includes existing request transactions that may appear or disappear due to changes in the Distributor 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 RequestTransactionLookupSession .

  • Method Details

    • getDistributorId

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

    • getDistributor

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

    • canRegisterForRequestTransactionNotifications

      boolean canRegisterForRequestTransactionNotifications()
      Tests if this user can register for RequestTransaction 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.

    • useFederatedDistributorView

      void useFederatedDistributorView()
      Federates the view for methods in this session. A federated view will include request transactions in distributors which are children of this distributor in the distributor hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedDistributorView

      void useIsolatedDistributorView()
      Isolates the view for methods in this session. An isolated view restricts notifications to this distributor only.
      Compliance:
      mandatory - This method is must be implemented.

    • reliableRequestTransactionNotifications

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

    • unreliableRequestTransactionNotifications

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

    • acknowledgeRequestTransactionNotification

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

    • registerForNewRequestTransactions

      void registerForNewRequestTransactions() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new request transactions. RequestTransactionReceiver.newRequestTransactions() is invoked when a new RequestTransaction appears in this distributor.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedRequestTransactions

      void registerForChangedRequestTransactions() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated request transactions. RequestTransactionReceiver.changedRequestTransactions() is invoked when a request transaction in this distributor is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedRequestTransaction

      void registerForChangedRequestTransaction(Id requestTransactionId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated request transaction. RequestTransactionReceiver.changedRequestTransactions() is invoked when the specified request transaction in this distributor is changed.
      Parameters:
      requestTransactionId - the Id of the RequestTransaction to monitor
      Throws:
      NullArgumentException - requestTransactionId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedRequestTransactions

      void registerForDeletedRequestTransactions() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted request transactions. RequestTransactionReceiver.deletedRequestTransactions() is invoked when a request transaction is deleted or removed from this distributor.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedRequestTransaction

      void registerForDeletedRequestTransaction(Id requestTransactionId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted request transaction. RequestTransactionReceiver.deletedRequestTransactions() is invoked when the specified request transaction is deleted or removed from this distributor.
      Parameters:
      requestTransactionId - the Id of the RequestTransaction to monitor
      Throws:
      NullArgumentException - requestTransactionId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.