Interface QueueEnablerSmartFrontOfficeSession

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

This session manages queries and sequencing to create "smart" dynamic catalogs. A QueueEnablerQuery can be retrieved from this session and mapped to this FrontOffice to create a virtual collection of QueueEnablers . The queue enablers may be sequenced using the QueueEnablerSearchOrder from this session.

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

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

    • canManageSmartFrontOffices

      boolean canManageSmartFrontOffices()
      Tests if this user can manage smart front offices. 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.

    • getQueueEnablerQuery

      QueueEnablerQuery getQueueEnablerQuery()
      Gets a queue enabler query.
      Returns:
      the queue enabler query
      Compliance:
      mandatory - This method must be implemented.

    • getQueueEnablerSearchOrder

      QueueEnablerSearchOrder getQueueEnablerSearchOrder()
      Gets a queue enabler search order.
      Returns:
      the queue enabler search order
      Compliance:
      mandatory - This method must be implemented.

    • applyQueueEnablerQuery

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

    • inspectQueueEnablerQuery

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

    • applyQueueEnablerSequencing

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

    • getQueueEnablerQueryFromInspector

      QueueQuery getQueueEnablerQueryFromInspector(QueueEnablerQueryInspector queueEnablerQueryInspector)
      Gets a queue enabler query from an inspector.
      Parameters:
      queueEnablerQueryInspector - a queue enabler query inspector
      Returns:
      the queue enabler query
      Throws:
      NullArgumentException - queueEnablerQueryInspector is null
      UnsupportedException - queueEnablerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.