Interface IssueProcessorEnablerNotificationSession

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

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

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

    • canRegisterForIssueProcessorEnablerNotifications

      boolean canRegisterForIssueProcessorEnablerNotifications()
      Tests if this user can register for IssueProcessorEnabler 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 processor 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.

    • reliableIssueProcessorEnablerNotifications

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

    • unreliableIssueProcessorEnablerNotifications

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

    • acknowledgeIssueProcessorEnablerNotification

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

    • registerForNewIssueProcessorEnablers

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

    • registerForChangedIssueProcessorEnablers

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

    • registerForChangedIssueProcessorEnabler

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

    • registerForDeletedIssueProcessorEnablers

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

    • registerForDeletedIssueProcessorEnabler

      void registerForDeletedIssueProcessorEnabler(Id issueProcessorEnablerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted issue processor enabler. IssueProcessorEnablerReceiver.deletedIssueProcessorEnabler() is invoked when the specified issue processor enabler is deleted or removed from this oubliette.
      Parameters:
      issueProcessorEnablerId - the Id of the IssueProcessorEnabler to monitor
      Throws:
      NullArgumentException - issueProcessorEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.