Interface SubjectQueryInspector

All Superinterfaces:
Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidFederateableQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector
public interface SubjectQueryInspector extends OsidObjectQueryInspector, OsidFederateableQueryInspector

This is the query inspector for examining subject queries.

  • Method Details

    • getCodeTerms

      StringTerm[] getCodeTerms()
      Gets the code query terms.
      Returns:
      the code terms
      Compliance:
      mandatory - This method must be implemented.

    • getAncestorSubjectIdTerms

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

    • getAncestorSubjectTerms

      SubjectQueryInspector[] getAncestorSubjectTerms()
      Gets the ancestor subject terms.
      Returns:
      the ancestor subject terms
      Compliance:
      mandatory - This method must be implemented.

    • getDescendantSubjectIdTerms

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

    • getDescendantSubjectTerms

      SubjectQueryInspector[] getDescendantSubjectTerms()
      Gets the descendant subject terms.
      Returns:
      the descendant subject terms
      Compliance:
      mandatory - This method must be implemented.

    • getRelevancyIdTerms

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

    • getRelevancyTerms

      RelevancyQueryInspector[] getRelevancyTerms()
      Gets the relevancy terms.
      Returns:
      the relevancy 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.

    • getSubjectQueryInspectorRecord

      SubjectQueryInspectorRecord getSubjectQueryInspectorRecord(Type subjectRecordType) throws OperationFailedException
      Gets the subject query inspector record corresponding to the given Subject record Type .
      Parameters:
      subjectRecordType - a subject record type
      Returns:
      the subject query inspector record
      Throws:
      NullArgumentException - subjectRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(subjectRecordType) is false
      Compliance:
      mandatory - This method must be implemented.