Interface QueueEnablerNotificationSession

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

This session defines methods to receive notifications on adds/changes to QueueEnablers in this FrontOffice . This also includes existing queue enablers that may appear or disappear due to changes in the FrontOffice hi erarchy, 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 QueueEnablerLookupSession .

  • Method Details

    • getFrontOfficeId

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

    • getFrontOffice

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

    • canRegisterForQueueEnablerNotifications

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

    • useFederatedFrontOfficeView

      void useFederatedFrontOfficeView()
      Federates the view for methods in this session. A federated view will include queue enablers in front offices which are children of this front office in the front office hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedFrontOfficeView

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

    • reliableQueueEnablerNotifications

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

    • unreliableQueueEnablerNotifications

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

    • acknowledgeQueueEnablerNotification

      void acknowledgeQueueEnablerNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
      Acknowledge a queue 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.

    • registerForNewQueueEnablers

      void registerForNewQueueEnablers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new queue enablers. QueueEnablerReceiver.newQueueEnablers:() is invoked when a new QueueEnabler appears in this front office.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedQueueEnablers

      void registerForChangedQueueEnablers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of updated queue enablers. QueueEnablerReceiver.changedQueueEnablers() is invoked when a QueueEnabler in this front office is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedQueueEnabler

      void registerForChangedQueueEnabler(Id queueEnablerId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of an updated queue enabler. QueueEnablerReceiver.changedQueueEnablers() is invoked when the specified QueueEnabler in this front office is changed.
      Parameters:
      queueEnablerId - the Id of the QueueEnabler to monitor
      Throws:
      NullArgumentException - queueEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedQueueEnablers

      void registerForDeletedQueueEnablers() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted queue enablers. QueueEnablerReceiver.deletedQueueEnablers() is invoked when a queue enabler is deleted or removed from this front office.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedQueueEnabler

      void registerForDeletedQueueEnabler(Id queueEnablerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted queue enabler. QueueEnablerReceiver.deletedQueueEnabler() is invoked when the specified queue enabler is deleted or removed from this front office.
      Parameters:
      queueEnablerId - the Id of the QueueEnabler to monitor
      Throws:
      NullArgumentException - queueEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.