Interface QueueEnablerQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
QueueEnablerSearchSession
public interface QueueEnablerQuerySession extends OsidSession

This session provides methods for searching among QueueEnabler objects. The search query is constructed using the QueueEnablerQuery .

This session defines views that offer differing behaviors for searching.

  • federated front office view: searches include queue enablers in front offices of which this front office is an ancestor in the front office hierarchy
  • isolated front office view: searches are restricted to queue enablers in this front office

Queue enablers may have a query record indicated by their respective record types. The query record is accessed via the FrontOfficeQuery .

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

    • canSearchQueueEnablers

      boolean canSearchQueueEnablers()
      Tests if this user can perform QueueEnabler searches. 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 not offer lookup operations to unauthorized users.
      Returns:
      false if search 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 queue 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 searches to this front office only.
      Compliance:
      mandatory - This method is must be implemented.

    • getQueueEnablerQuery

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

    • getQueueEnablersByQuery

      QueueEnablerList getQueueEnablersByQuery(QueueEnablerQuery queueEnablerQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of QueueEnablers matching the given search.
      Parameters:
      queueEnablerQuery - the queue enabler query
      Returns:
      the returned QueueEnablerList
      Throws:
      NullArgumentException - queueEnablerQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - queueEnablerQuery did not originate from getQueueEnablerQuery()
      Compliance:
      mandatory - This method must be implemented.