Interface RelevancyQueryInspector

All Superinterfaces:
Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidRelationshipQueryInspector, OsidTemporalQueryInspector
public interface RelevancyQueryInspector extends OsidRelationshipQueryInspector

This is the query inspector for examining relevancy queries.

Like all OsidQueryInspectors, RelevancyQueryInspector is stateful and must not be accessed by multiple processing threads.

  • Method Details

    • getSubjectIdTerms

      IdTerm[] getSubjectIdTerms()
      Gets the subject Id terms.
      Specified by:
      getSubjectIdTerms in interface OsidObjectQueryInspector
      Returns:
      the subject Id terms
      Compliance:
      mandatory - This method must be implemented.

    • getSubjectTerms

      SubjectQueryInspector[] getSubjectTerms()
      Gets the subject terms.
      Specified by:
      getSubjectTerms in interface OsidObjectQueryInspector
      Returns:
      the subject terms
      Compliance:
      mandatory - This method must be implemented.

    • getMappedIdTerms

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

    • getOntologyIdTerms

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

    • getOntologyTerms

      OntologyQueryInspector[] getOntologyTerms()
      Gets the ontology terms.
      Returns:
      the ontology terms
      Compliance:
      mandatory - This method must be implemented.

    • getRelevancyQueryInspectorRecord

      RelevancyQueryInspectorRecord getRelevancyQueryInspectorRecord(Type relevancyRecordType) throws OperationFailedException
      Gets the relevancy query inspector record corresponding to the given Relevancy record Type.
      Parameters:
      relevancyRecordType - a relevancy record type
      Returns:
      the relevancy query inspector record
      Throws:
      NullArgumentException - relevancyRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(relevancyRecordType) is false
      Compliance:
      mandatory - This method must be implemented.