Interface QueueProcessorEnablerQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
QueueProcessorEnablerSearchSession
public interface QueueProcessorEnablerQuerySession extends OsidSession

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

This session defines views that offer differing behaviors for searching.

  • federated front office view: searches include queue processor enablers 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 enablers in this office

Queue processor enablers may have a query record indicated by their respective record types. The query record is accessed via the 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.

    • canSearchQueueProcessorEnablers

      boolean canSearchQueueProcessorEnablers()
      Tests if this user can perform QueueProcessorEnabler 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 enablers 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.

    • getQueueProcessorEnablerQuery

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

    • getQueueProcessorEnablersByQuery

      QueueProcessorEnablerList getQueueProcessorEnablersByQuery(QueueProcessorEnablerQuery queueProcessorEnablerQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of QueueProcessorEnablers matching the given queue processor enabler query.
      Parameters:
      queueProcessorEnablerQuery - the queue processor enabler query
      Returns:
      the returned QueueProcessorEnablerList
      Throws:
      NullArgumentException - queueProcessorEnablerQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - queueProcessorEnablerQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.