Interface QueueConstrainerSmartFrontOfficeSession

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

This session manages queries and sequencing to create "smart" dynamic front office. a QueueConstrainerQuery can be retrieved from this session and mapped to this FrontOffice to create a virtual collection of queue constrainers. The queue constrainer may be sequenced using the QueueConstrainerSearchOrder from this session.

This FrontOffice has a default query that matches any queue constrainer and a default search order that specifies no sequencing. The queries may be examined using a QueueConstrainerQueryInspector . The query may be modified by converting the inspector back to a QueueConstrainerQuery .

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

    • canManageSmartFrontOffices

      boolean canManageSmartFrontOffices()
      Tests if this user can manage smart front office. A return of true does not guarantee successful authorization. A return of false indicates that it is known 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 operations to unauthorized users.
      Returns:
      false if smart front office management is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getQueueConstrainerQuery

      QueueConstrainerQuery getQueueConstrainerQuery()
      Gets a queue constrainer query.
      Returns:
      the queue constrainer query
      Compliance:
      mandatory - This method must be implemented.

    • getQueueConstrainerSearchOrder

      QueueConstrainerSearchOrder getQueueConstrainerSearchOrder()
      Gets a queue constrainer search order.
      Returns:
      the queue constrainer search order
      Compliance:
      mandatory - This method must be implemented.

    • applyQueueConstrainerQuery

      void applyQueueConstrainerQuery(QueueConstrainerQuery queueConstrainerQuery) throws OperationFailedException, PermissionDeniedException
      Applies a queue constrainer query to this front office.
      Parameters:
      queueConstrainerQuery - the queue constrainer query
      Throws:
      NullArgumentException - queueConstrainerQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - queueConstrainerQuery not of this service
      Compliance:
      mandatory - This method must be implemented.

    • inspectQueueConstrainerQuery

      QueueConstrainerQueryInspector inspectQueueConstrainerQuery() throws OperationFailedException, PermissionDeniedException
      Gets a queue constrainer query inspector for this front office.
      Returns:
      the queue constrainer query inspector
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • applyQueueConstrainerSequencing

      void applyQueueConstrainerSequencing(QueueConstrainerSearchOrder queueConstrainerSearchOrder) throws OperationFailedException, PermissionDeniedException
      Applies a queue constrainer search order to this front office.
      Parameters:
      queueConstrainerSearchOrder - the queue constrainer search order
      Throws:
      NullArgumentException - queueConstrainerSearchOrder is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - queueConstrainerSearchOrder not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getQueueConstrainerQueryFromInspector

      QueueConstrainerQuery getQueueConstrainerQueryFromInspector(QueueConstrainerQueryInspector queueConstrainerQueryInspector)
      Gets a queue constrainer query from an inspector.
      Parameters:
      queueConstrainerQueryInspector - a queue constrainer query inspector
      Returns:
      the queue constrainer query
      Throws:
      NullArgumentException - queueConstrainerQueryInspector is null
      UnsupportedException - queueConstrainerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.