Interface InquestQuery

All Superinterfaces:
Extensible, OsidBrowsableQuery, OsidCatalogQuery, OsidExtensibleQuery, OsidFederateableQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidSourceableQuery, Suppliable
public interface InquestQuery extends OsidCatalogQuery

This is the query for searching inquests. Each method match specifies an AND term while multiple invocations of the same method produce a nested OR .

  • Method Details

    • matchInquiryId

      void matchInquiryId(Id inquiryId, boolean match)
      Sets the inquiry Id for this query to match inquests that have a related response.
      Parameters:
      inquiryId - an inquiry Id
      match - true if a positive match, false for negative match
      Throws:
      NullArgumentException - inquiryId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearInquiryIdTerms

      void clearInquiryIdTerms()
      Clears the inquiry Id query terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsInquiryQuery

      boolean supportsInquiryQuery()
      Tests if an InquiryQuery is available.
      Returns:
      true if an inquiry query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getInquiryQuery

      InquiryQuery getInquiryQuery()
      Gets the query for an inquiry. Multiple retrievals produce a nested OR term.
      Returns:
      the inquiry query
      Throws:
      UnimplementedException - supportsInquiryQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsInquiryQuery()} is {@code true} .

    • matchAnyInquiry

      void matchAnyInquiry(boolean match)
      Matches inquests that have any inquiry.
      Parameters:
      match - true to match inquests with any inquiry, false to match inquests with no inquiry
      Compliance:
      mandatory - This method must be implemented.

    • clearInquiryTerms

      void clearInquiryTerms()
      Clears the inquiry query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchAuditId

      void matchAuditId(Id auditId, boolean match)
      Sets the audit Id for this query.
      Parameters:
      auditId - the audit Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - auditId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearAuditIdTerms

      void clearAuditIdTerms()
      Clears the audit Id query terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsAuditQuery

      boolean supportsAuditQuery()
      Tests if an AuditQuery is available.
      Returns:
      true if an audit query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getAuditQuery

      AuditQuery getAuditQuery()
      Gets the query for an audit. Multiple retrievals produce a nested OR term.
      Returns:
      the audit query
      Throws:
      UnimplementedException - supportsAuditQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsAuditQuery()} is {@code true} .

    • matchAnyAudit

      void matchAnyAudit(boolean match)
      Matches inquests with any audit.
      Parameters:
      match - true to match inquests with any audit, false to match inquests with no audit
      Compliance:
      mandatory - This method must be implemented.

    • clearAuditTerms

      void clearAuditTerms()
      Clears the audit query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchResponseId

      void matchResponseId(Id responseId, boolean match)
      Sets the response Id for this query.
      Parameters:
      responseId - the response Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - responseId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearResponseIdTerms

      void clearResponseIdTerms()
      Clears the response Id query terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsResponseQuery

      boolean supportsResponseQuery()
      Tests if a ResponseQuery is available.
      Returns:
      true if a response query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getResponseQuery

      ResponseQuery getResponseQuery()
      Gets the query for a response. Multiple retrievals produce a nested OR term.
      Returns:
      the response query
      Throws:
      UnimplementedException - supportsResponseQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsResponseQuery()} is {@code true} .

    • matchAnyResponse

      void matchAnyResponse(boolean match)
      Matches inquests with any response.
      Parameters:
      match - true to match inquests with any response, false to match inquests with no response
      Compliance:
      mandatory - This method must be implemented.

    • clearResponseTerms

      void clearResponseTerms()
      Clears the response query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchAncestorInquestId

      void matchAncestorInquestId(Id inquestId, boolean match)
      Sets the inquest Id for this query to match inquests that have the specified inquest as an ancestor.
      Parameters:
      inquestId - an inquest Id
      match - true for a positive match, false for negative match
      Throws:
      NullArgumentException - inquestId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearAncestorInquestIdTerms

      void clearAncestorInquestIdTerms()
      Clears the ancestor inquest Id query terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsAncestorInquestQuery

      boolean supportsAncestorInquestQuery()
      Tests if an InquestQuery is available.
      Returns:
      true if an inquest query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getAncestorInquestQuery

      InquestQuery getAncestorInquestQuery()
      Gets the query for an inquest. Multiple retrievals produce a nested OR term.
      Returns:
      the inquest query
      Throws:
      UnimplementedException - supportsAncestorInquestQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsAncestorInquestQuery()} is {@code true} .

    • matchAnyAncestorInquest

      void matchAnyAncestorInquest(boolean match)
      Matches inquests with any ancestor.
      Parameters:
      match - true to match inquests with any ancestor, false to match root inquests
      Compliance:
      mandatory - This method must be implemented.

    • clearAncestorInquestTerms

      void clearAncestorInquestTerms()
      Clears the ancestor inquest query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchDescendantInquestId

      void matchDescendantInquestId(Id inquestId, boolean match)
      Sets the inquest Id for this query to match inquests that have the specified inquest as a descendant.
      Parameters:
      inquestId - an inquest Id
      match - true for a positive match, false for negative match
      Throws:
      NullArgumentException - inquestId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearDescendantInquestIdTerms

      void clearDescendantInquestIdTerms()
      Clears the descendant inquest Id query terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsDescendantInquestQuery

      boolean supportsDescendantInquestQuery()
      Tests if an InquestQuery is available.
      Returns:
      true if an inquest query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getDescendantInquestQuery

      InquestQuery getDescendantInquestQuery()
      Gets the query for an inquest/ Multiple retrievals produce a nested OR term.
      Returns:
      the inquest query
      Throws:
      UnimplementedException - supportsDescendantInquestQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsDescendantInquestQuery()} is {@code true} .

    • matchAnyDescendantInquest

      void matchAnyDescendantInquest(boolean match)
      Matches inquests with any descendant.
      Parameters:
      match - true to match inquests with any descendant, false to match leaf inquests
      Compliance:
      mandatory - This method must be implemented.

    • clearDescendantInquestTerms

      void clearDescendantInquestTerms()
      Clears the descendant inquest query terms.
      Compliance:
      mandatory - This method must be implemented.

    • getInquestQueryRecord

      InquestQueryRecord getInquestQueryRecord(Type inquestRecordType) throws OperationFailedException
      Gets the inquest query record corresponding to the given Inquest record Type .Multiple record retrievals produce a nested OR term.
      Parameters:
      inquestRecordType - an inquest record type
      Returns:
      the inquest query record
      Throws:
      NullArgumentException - inquestRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(inquestRecordType) is false
      Compliance:
      mandatory - This method must be implemented.