Interface QueueConstrainerEnablerNotificationSession

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

This session defines methods to receive notifications on adds/changes to QueueConstrainerEnabler objects in this FrontFront Office . This also includes existing QueueConstrainerEnablers that may appear or disappear due to changes in the FrontOffice 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 QueueConstrainerEnablerLookupSession .

  • 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 office
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canRegisterForQueueConstrainerEnablerNotifications

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

    • reliableQueueConstrainerEnablerNotifications

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

    • unreliableQueueConstrainerEnablerNotifications

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

    • acknowledgeQueueConstrainerEnablerNotification

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

    • registerForNewQueueConstrainerEnablers

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

    • registerForChangedQueueConstrainerEnablers

      void registerForChangedQueueConstrainerEnablers() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated front office enabelrs. QueueConstrainerEnablerReceiver.changedQueueConstrainerEnablers() is invoked when a queue constrainer enabler in this front office is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedQueueConstrainerEnabler

      void registerForChangedQueueConstrainerEnabler(Id queueConstrainerEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Registers for notification of an updated queue constrainer enabler. ProvisionableReceiver.changedQueueConstrainerEnablers() is invoked when the specified queue constrainer enabler in this front office is changed.
      Parameters:
      queueConstrainerEnablerId - the Id of the QueueConstrainerEnabler to monitor
      Throws:
      NotFoundException - a queue constrainer enabler was not found in this queue matchmaker identified by the given Id
      NullArgumentException - queueConstrainerEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedQueueConstrainerEnablers

      void registerForDeletedQueueConstrainerEnablers() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted queue constrainer enablers. QueueConstrainerEnablerReceiver.deletedQueueConstrainerEnablers() is invoked when a queue constrainer 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.

    • registerForDeletedQueueConstrainerEnabler

      void registerForDeletedQueueConstrainerEnabler(Id queueConstrainerEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted queue constrainer enabler. QueueConstrainerEnablerReceiver.deletedQueueConstrainerEnablers() is invoked when the specified queue constrainer enabler is deleted or removed from this front office.
      Parameters:
      queueConstrainerEnablerId - the Id of the QueueConstrainerEnabler to monitor
      Throws:
      NotFoundException - a queue constrainer enabler was not found in this queue matchmaker identified by the given Id
      NullArgumentException - queueConstrainerEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.