Interface IssueNotificationSession

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

This session defines methods to receive notifications on adds/changes to Issue objects in this Oubliette . 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 IssueLookupSession .

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

    • canRegisterForIssueNotifications

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

    • useFederatedOublietteView

      void useFederatedOublietteView()
      Federates the view for methods in this session. A federated view will include issues 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.

    • reliableIssueNotifications

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

    • unreliableIssueNotifications

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

    • acknowledgeIssueNotification

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

    • registerForNewIssues

      void registerForNewIssues() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new issues. IssueReceiver.newIssues() is invoked when a new Issue appears in this oubliette.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedIssues

      void registerForChangedIssues() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated issues. IssueReceiver.changedIssues() is invoked when an issue in this oubliette is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedIssue

      void registerForChangedIssue(Id issueId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Registers for notification of an updated issue. IssueReceiver.changedIssues() is invoked when the specified issue in this oubliette is changed.
      Parameters:
      issueId - the Id of the Issue to monitor
      Throws:
      NotFoundException - an issue was not found in this oubliette identified by the given Id
      NullArgumentException - issueId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedIssues

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

    • registerForDeletedIssue

      void registerForDeletedIssue(Id issueId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted issue. IssueReceiver.deletedIssues() is invoked when the specified issue is deleted or removed from this oubliette.
      Parameters:
      issueId - the Id of the Issue to monitor
      Throws:
      NotFoundException - an issue was not found identified by the given Id
      NullArgumentException - issueId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.