Interface ResponseQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
ResponseSearchSession
public interface ResponseQuerySession extends OsidSession

This session provides methods for searching among Responses . The search query is constructed using the ResponseQuery .

This session defines views that offer differing behaviors for searching.

  • federated inquest view: searches include responses in inquests of which this inquest is an ancestor in the inquest hierarchy
  • isolated inquest view: searches are restricted to responses in this inquest

responses may have a query record indicated by their respective record types. The query record is accessed via the ResponseQuery .

  • Method Details

    • getInquestId

      Id getInquestId()
      Gets the Inquest Id associated with this session.
      Returns:
      the Inquest Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getInquest

      Inquest getInquest() throws OperationFailedException, PermissionDeniedException
      Gets the Inquest associated with this session.
      Returns:
      the inquest
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canSearchResponses

      boolean canSearchResponses()
      Tests if this user can perform Response 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.

    • useFederatedInquestView

      void useFederatedInquestView()
      Federates the view for methods in this session. A federated view will include responses in inquests which are children of this inquest in the inquest hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedInquestView

      void useIsolatedInquestView()
      Isolates the view for methods in this session. An isolated view restricts lookups to this inquest only.
      Compliance:
      mandatory - This method is must be implemented.

    • getResponseQuery

      ResponseQuery getResponseQuery()
      Gets a response query.
      Returns:
      the response query
      Compliance:
      mandatory - This method must be implemented.

    • getResponsesByQuery

      ResponseList getResponsesByQuery(ResponseQuery responseQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of Responses matching the given response query.
      Parameters:
      responseQuery - the response query
      Returns:
      the returned ResponseList
      Throws:
      NullArgumentException - responseQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - responseQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.