Interface IssueConstrainerNotificationSession

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

This session defines methods to receive notifications on adds/changes to IssueConstrainers in this Oubliette . This also includes existing issue constrainers 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 IssueConstrainerLookupSession .

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

    • canRegisterForIssueConstrainerNotifications

      boolean canRegisterForIssueConstrainerNotifications()
      Tests if this user can register for IssueConstrai ner 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.

    • useFederatedIssueConstrainerHouseView

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

    • reliableIssueConstrainerNotifications

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

    • unreliableIssueConstrainerNotifications

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

    • acknowledgeIssueConstrainerNotification

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

    • registerForNewIssueConstrainers

      void registerForNewIssueConstrainers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new issue constrainers. IssueConstrainerReceiver.newIssueConstrainers() is invoked when a new IssueConstrainer appears in this oubliette.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedIssueConstrainers

      void registerForChangedIssueConstrainers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of updated issue constrainers. IssueConstrainerReceiver.changedIssueConstrainers() is invoked when an IssueConstrainer in this oubliette is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedIssueConstrainer

      void registerForChangedIssueConstrainer(Id issueConstrainerId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of an updated issue constrainer. IssueConstrainerReceiver.changedIssueConstrainers() is invoked when the specified IssueConstrainer in this oubliette is changed.
      Parameters:
      issueConstrainerId - the Id of the IssueConstrainer to monitor
      Throws:
      NullArgumentException - issueConstrainerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedIssueConstrainers

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

    • registerForDeletedIssueConstrainer

      void registerForDeletedIssueConstrainer(Id issueConstrainerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a delete issue constrainer. IssueConstrainerReceiver.deletedIssueConstrainers() is invoked when the specified issue constrainer is deleted or removed from this oubliette.
      Parameters:
      issueConstrainerId - the Id of the IssueConstrainer to monitor
      Throws:
      NullArgumentException - issueConstrainerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.