Interface InquiryEnablerNotificationSession

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

This session defines methods to receive notifications on adds/changes to InquiryEnabler objects in this Inquest . This also includes existing InquiryEnablers that may appear or disappear due to changes in the Inquest 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 InquiryEnablerLookupSession .

  • Method Details

    • getInquestId

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

    • getInquest

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

    • canRegisterForInquiryEnablerNotifications

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

    • useFederatedInquestView

      void useFederatedInquestView()
      Federates the view for methods in this session. A federated view will include enablers in inquests which are children of this inquest in the inquest hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedInquestView

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

    • reliableInquiryEnablerNotifications

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

    • unreliableInquiryEnablerNotifications

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

    • acknowledgeInquiryEnablerNotification

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

    • registerForNewInquiryEnablers

      void registerForNewInquiryEnablers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new inquiry enablers. InquiryEnablerReceiver.newInquiryEnablers() is invoked when a new InquiryEnabler appears in this inquest.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedInquiryEnablers

      void registerForChangedInquiryEnablers() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated inquiry enablers. InquiryEnablerReceiver.changedInquiryEnablers() is invoked when an inquiry enabler in this inquest is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedInquiryEnabler

      void registerForChangedInquiryEnabler(Id inquiryEnablerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated inquiry enabler. ProvisionableReceiver.changedInquiryEnablers() is invoked when the specified inquiry enabler in this inquest is changed.
      Parameters:
      inquiryEnablerId - the Id of the InquiryEnabler to monitor
      Throws:
      NullArgumentException - inquiryEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedInquiryEnablers

      void registerForDeletedInquiryEnablers() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted inquiry enablers. InquiryEnablerReceiver.deletedInquiryEnablers() is invoked when an inquiry enabler is deleted or removed from this inquest.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedInquiryEnabler

      void registerForDeletedInquiryEnabler(Id inquiryEnablerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted inquiry enabler. InquiryEnablerReceiver.deletedInquiryEnablers() is invoked when the specified inquiry enabler is deleted or removed from this inquest.
      Parameters:
      inquiryEnablerId - the Id of the InquiryEnabler to monitor
      Throws:
      NullArgumentException - inquiryEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.