Interface InquiryQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
InquirySearchSession
public interface InquiryQuerySession extends OsidSession

This session provides methods for searching among Inquiries. The search query is constructed using the InquiryQuery.

This session defines views that offer differing behaviors for searching.

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

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

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

    • canSearchInquiries

      boolean canSearchInquiries()
      Tests if this user can perform Inquiry 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 inquiries 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 searches to this inquest only.
      Compliance:
      mandatory - This method is must be implemented.

    • getInquiryQuery

      InquiryQuery getInquiryQuery()
      Gets an inquiry query.
      Returns:
      the inquiry query
      Compliance:
      mandatory - This method must be implemented.

    • getInquiriesByQuery

      InquiryList getInquiriesByQuery(InquiryQuery inquiryQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of Inquiries matching the given inquiry query,
      Parameters:
      inquiryQuery - the inquiry query
      Returns:
      the returned InquiryList
      Throws:
      NullArgumentException - inquiryQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - inquiryQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.