Interface QueueProcessorEnablerSmartFrontOfficeSession

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

This session manages queries and sequencing to create "smart" dynamic front office. a QueueProcessorEnablerQuery can be retrieved from this session and mapped to this FrontOffice to create a virtual collection of queue processor enablers. The queue processor enablers may be sequenced using the QueueProcessorEnablerSearchOrder from this session.

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

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

    • getQueueProcessorEnablerQuery

      QueueProcessorEnablerQuery getQueueProcessorEnablerQuery()
      Gets a queue processor enabler query.
      Returns:
      the queue processor enabler query
      Compliance:
      mandatory - This method must be implemented.

    • getQueueProcessorEnablerSearchOrder

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

    • applyQueueProcessorEnablerQuery

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

    • inspectQueueProcessorEnablerQuery

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

    • applyQueueProcessorEnablerSequencing

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

    • getQueueProcessorEnablerQueryFromInspector

      QueueProcessorEnablerQuery getQueueProcessorEnablerQueryFromInspector(QueueProcessorEnablerQueryInspector queueProcessorEnablerQueryInspector)
      Gets a queue processor enabler query from an inspector.
      Parameters:
      queueProcessorEnablerQueryInspector - a queue processor enabler query inspector
      Returns:
      the queue processor enabler query
      Throws:
      NullArgumentException - queueProcessorEnablerQueryInspector is null
      UnsupportedException - queueProcessorEnablerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.