Interface IssueConstrainerEnablerNotificationSession

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

This session defines methods to receive notifications on adds/changes to IssueConstrainerEnabler objects in this Oubliette . This also includes existing issue constrainer enablers that may appear or disappear due to changes in the Oubliette hier archy, 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 IssueConstrainerEnablerLookupSession .

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

    • canRegisterForIssueConstrainerEnablerNotifications

      boolean canRegisterForIssueConstrainerEnablerNotifications()
      Tests if this user can register for IssueConstrainerEnabler 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 issue constrainer 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.

    • reliableIssueConstrainerEnablerNotifications

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

    • unreliableIssueConstrainerEnablerNotifications

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

    • acknowledgeIssueConstrainerEnablerNotification

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

    • registerForNewIssueConstrainerEnablers

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

    • registerForChangedIssueConstrainerEnablers

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

    • registerForChangedIssueConstrainerEnabler

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

    • registerForDeletedIssueConstrainerEnablers

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

    • registerForDeletedIssueConstrainerEnabler

      void registerForDeletedIssueConstrainerEnabler(Id issueConstrainerEnablerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted issue constrainer enabler. IssueConstrainerEnablerReceiver.deletedIssueConstrainerEnabler() is invoked when the specified issue constrainer enabler is deleted or removed from this oubliette.
      Parameters:
      issueConstrainerEnablerId - the Id of the IssueConstrainerEnabler to monitor
      Throws:
      NullArgumentException - issueConstrainerEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.