Interface QueueConstrainerNotificationSession

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

This session defines methods to receive notifications on adds/changes to QueueConstrainer objects in this FrontFront Office . This also includes existing QueueConstrainers 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 QueueConstrainerLookupSession .

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

    • canRegisterForQueueConstrainerNotifications

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

    • reliableQueueConstrainerNotifications

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

    • unreliableQueueConstrainerNotifications

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

    • acknowledgeQueueConstrainerNotification

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

    • registerForNewQueueConstrainers

      void registerForNewQueueConstrainers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new queue constrainers. QueueConstrainerReceiver.newQueueConstrainers() is invoked when a new QueueConstrainer appears in this front office.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedQueueConstrainers

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

    • registerForChangedQueueConstrainer

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

    • registerForDeletedQueueConstrainers

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

    • registerForDeletedQueueConstrainer

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