Interface CourseEntryQueryInspector

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

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

    • getStudentIdTerms

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

    • getStudentTerms

      ResourceQueryInspector[] getStudentTerms()
      Gets the student query terms.
      Returns:
      the resource query terms
      Compliance:
      mandatory - This method must be implemented.

    • getCourseIdTerms

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

    • getCourseTerms

      CourseQueryInspector[] getCourseTerms()
      Gets the course query terms.
      Returns:
      the course terms
      Compliance:
      mandatory - This method must be implemented.

    • getTermIdTerms

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

    • getTermTerms

      TermQueryInspector[] getTermTerms()
      Gets the term query terms.
      Returns:
      the term terms
      Compliance:
      mandatory - This method must be implemented.

    • getIsRegistrationKnownTerms

      BooleanTerm[] getIsRegistrationKnownTerms()
      Gets the is registration known query terms.
      Returns:
      the is registration known terms
      Compliance:
      mandatory - This method must be implemented.

    • getCourseBeginDateTerms

      DateTimeRangeTerm[] getCourseBeginDateTerms()
      Gets the course begin date query terms.
      Returns:
      the course begin date terms
      Compliance:
      mandatory - This method must be implemented.

    • getCourseEndDateTerms

      DateTimeRangeTerm[] getCourseEndDateTerms()
      Gets the course end date query terms.
      Returns:
      the course end date terms
      Compliance:
      mandatory - This method must be implemented.

    • getCompleteTerms

      BooleanTerm[] getCompleteTerms()
      Gets the complete query terms.
      Returns:
      the complete terms
      Compliance:
      mandatory - This method must be implemented.

    • getCreditScaleIdTerms

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

    • getCreditScaleTerms

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

    • getCreditsEarnedTerms

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

    • getGradeIdTerms

      IdTerm[] getGradeIdTerms()
      Gets the grade Id query terms.
      Returns:
      the grade Id query 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.

    • getScoreScaleIdTerms

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

    • getScoreScaleTerms

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

    • getScoreTerms

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

    • getRegistrationIdTerms

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

    • getRegistrationTerms

      RegistrationQueryInspector[] getRegistrationTerms()
      Gets the registration query terms.
      Returns:
      the registration query terms
      Compliance:
      mandatory - This method must be implemented.

    • getCourseCatalogIdTerms

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

    • getCourseCatalogTerms

      CourseCatalogQueryInspector[] getCourseCatalogTerms()
      Gets the course catalog query terms.
      Returns:
      the course catalog query terms
      Compliance:
      mandatory - This method must be implemented.

    • getCourseEntryQueryInspectorRecord

      CourseEntryQueryInspectorRecord getCourseEntryQueryInspectorRecord(Type courseEntryRecordType) throws OperationFailedException
      Gets the course entry query inspector record corresponding to the given CourseEntry record Type . Multiple record retrievals produce a nested OR term.
      Parameters:
      courseEntryRecordType - a course entry record type
      Returns:
      the course entry query inspector record
      Throws:
      NullArgumentException - courseEntryRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(courseEntryRecordType) is false
      Compliance:
      mandatory - This method must be implemented.