Interface QueueConstrainerQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
QueueConstrainerSearchSession
public interface QueueConstrainerQuerySession extends OsidSession

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

This session defines views that offer differing behaviors for searching.

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

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

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

    • canSearchQueueConstrainers

      boolean canSearchQueueConstrainers()
      Tests if this user can perform QueueConstrainer 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 constrainer 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.

    • getQueueConstrainerQuery

      QueueConstrainerQuery getQueueConstrainerQuery()
      Gets a queue constrainer query.
      Returns:
      the queue constrainer query
      Compliance:
      mandatory - This method must be implemented.

    • getQueueConstrainersByQuery

      QueueConstrainerList getQueueConstrainersByQuery(QueueConstrainerQuery queueConstrainerQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of QueueConstrainers matching the given queue constrainer query.
      Parameters:
      queueConstrainerQuery - the queue constrainer query
      Returns:
      the returned QueueConstrainerList
      Throws:
      NullArgumentException - queueConstrainerQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - queueConstrainerQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.