Interface ResultQueryInspector

All Superinterfaces:
Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidSubjugateableQueryInspector, OsidTemporalQueryInspector
public interface ResultQueryInspector extends OsidObjectQueryInspector, OsidTemporalQueryInspector, OsidSubjugateableQueryInspector

The query inspectors provide a means of accessing the match terms of a query. These interfaces are used to examine the actual query terms used in a search or that may be used to create a smart catalog. Query inspectors may be converted to OsidQuery interfaces for reuse or modification in the search sessions.

  • Method Details

    • getParticipantIdTerms

      IdTerm[] getParticipantIdTerms()
      Gets the participant Id query terms.
      Returns:
      the participant Id terms
      Compliance:
      mandatory - This method must be implemented.

    • getParticipantTerms

      ParticipantQueryInspector[] getParticipantTerms()
      Gets the participant query terms.
      Returns:
      the participant terms
      Compliance:
      mandatory - This method must be implemented.

    • getGradeIdTerms

      IdTerm[] getGradeIdTerms()
      Gets the grade Id query terms.
      Returns:
      the grade Id terms
      Compliance:
      mandatory - This method must be implemented.

    • getGradeTerms

      GradeQueryInspector[] getGradeTerms()
      Gets the grade query terms.
      Returns:
      the grade terms
      Compliance:
      mandatory - This method must be implemented.

    • getValueTerms

      DecimalRangeTerm[] getValueTerms()
      Gets the value query terms.
      Returns:
      the value terms
      Compliance:
      mandatory - This method must be implemented.

    • getCatalogueIdTerms

      IdTerm[] getCatalogueIdTerms()
      Gets the catalogue Id query terms.
      Returns:
      the catalogue Id terms
      Compliance:
      mandatory - This method must be implemented.

    • getCatalogueTerms

      CatalogueQueryInspector[] getCatalogueTerms()
      Gets the catalogue query terms.
      Returns:
      the catalogue terms
      Compliance:
      mandatory - This method must be implemented.

    • getResultQueryInspectorRecord

      ResultQueryInspectorRecord getResultQueryInspectorRecord(Type resultRecordType) throws OperationFailedException
      Gets the result query inspector record corresponding to the given Result record Type .
      Parameters:
      resultRecordType - a result record type
      Returns:
      the result inspector query record
      Throws:
      NullArgumentException - resultRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(resultRecordType) is false
      Compliance:
      mandatory - This method must be implemented.