Interface QueueProcessorQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
QueueProcessorSearchSession
public interface QueueProcessorQuerySession extends OsidSession

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

This session defines views that offer differing behaviors for searching.

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

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

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

    • canSearchQueueProcessors

      boolean canSearchQueueProcessors()
      Tests if this user can perform QueueProcessor lookups. 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 processor in front offices which are children of this queue 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 lookups to this front office only.
      Compliance:
      mandatory - This method is must be implemented.

    • getQueueProcessorQuery

      QueueProcessorQuery getQueueProcessorQuery()
      Gets a queue processor query.
      Returns:
      the queue processor query
      Compliance:
      mandatory - This method must be implemented.

    • getQueueProcessorsByQuery

      QueueProcessorList getQueueProcessorsByQuery(QueueProcessorQuery queueProcessorQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of QueueProcessors matching the given queue processor query.
      Parameters:
      queueProcessorQuery - the queue processor query
      Returns:
      the returned QueueProcessorList
      Throws:
      NullArgumentException - queueProcessorQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - queueProcessorQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.