Interface IssueEnablerNotificationSession

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

This session defines methods to receive notifications on adds/changes to IssueEnablers in this Oubliette . This also includes existing issue enablers that may appear or disappear due to changes in the Oubliette 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 IssueEnablerLookupSession .

  • Method Details

    • getOublietteId

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

    • getOubliette

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

    • canRegisterForIssueEnablerNotifications

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

    • useFederatedIssueEnablerHouseView

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

    • useIsolatedOublietteView

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

    • reliableIssueEnablerNotifications

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

    • unreliableIssueEnablerNotifications

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

    • acknowledgeIssueEnablerNotification

      void acknowledgeIssueEnablerNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
      Acknowledge an issue 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.

    • registerForNewIssueEnablers

      void registerForNewIssueEnablers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new issue enablers. IssueEnablerReceiver.newIssueEnablers() is invoked when a new IssueEnabler appears in this oubliette.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedIssueEnablers

      void registerForChangedIssueEnablers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of updated issue enablers. IssueEnablerReceiver.changedIssueEnablers() is invoked when an IssueEnabler in this oubliette is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedIssueEnabler

      void registerForChangedIssueEnabler(Id issueEnablerId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of an updated issue enabler. IssueEnablerReceiver.changedIssueEnablers() is invoked when the specified IssueEnabler in this oubliette is changed.
      Parameters:
      issueEnablerId - the Id of the IssueEnabler to monitor
      Throws:
      NullArgumentException - issueEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedIssueEnablers

      void registerForDeletedIssueEnablers() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted issue enablers. IssueEnablerReceiver.deletedIssueEnablers() is invoked when an issue enabler is deleted or removed from this oubliette.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedIssueEnabler

      void registerForDeletedIssueEnabler(Id issueEnablerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a delete issue enabler. IssueEnablerReceiver.deletedIssueEnablers() is invoked when the specified issue enabler is deleted or removed from this oubliette.
      Parameters:
      issueEnablerId - the Id of the IssueEnabler to monitor
      Throws:
      NullArgumentException - issueEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.