Interface CourseEntryQuery

All Superinterfaces:
Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidRelationshipQuery, OsidTemporalQuery, Suppliable
public interface CourseEntryQuery extends OsidRelationshipQuery

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

  • Method Details

    • matchStudentId

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

    • clearStudentIdTerms

      void clearStudentIdTerms()
      Clears the student Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsStudentQuery

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

    • getStudentQuery

      ResourceQuery getStudentQuery()
      Gets the query for a student option. Multiple retrievals produce a nested OR term.
      Returns:
      a student query
      Throws:
      UnimplementedException - supportsStudentQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStudentQuery()} is {@code true} .

    • clearStudentTerms

      void clearStudentTerms()
      Clears the student option terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchCourseId

      void matchCourseId(Id courseId, boolean match)
      Sets the course Id for this query to match entries that have an entry for the given course.
      Parameters:
      courseId - a course Id
      match - true if a positive match, false for a negative match
      Throws:
      NullArgumentException - courseId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearCourseIdTerms

      void clearCourseIdTerms()
      Clears the course Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsCourseQuery

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

    • getCourseQuery

      CourseQuery getCourseQuery()
      Gets the query for a course entry. Multiple retrievals produce a nested OR term.
      Returns:
      a course query
      Throws:
      UnimplementedException - supportsCourseQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCourseQuery()} is {@code true} .

    • clearCourseTerms

      void clearCourseTerms()
      Clears the course terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchTermId

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

    • clearTermIdTerms

      void clearTermIdTerms()
      Clears the term Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsTermQuery

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

    • getTermQuery

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

    • clearTermTerms

      void clearTermTerms()
      Clears the term terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchIsRegistrationKnown

      void matchIsRegistrationKnown(boolean match)
      Matches course entries where the registration dates are known.
      Parameters:
      match - true for a positive match, false for a negative match
      Compliance:
      mandatory - This method must be implemented.

    • clearIsRegistrationKnownTerms

      void clearIsRegistrationKnownTerms()
      Clears the is registration known terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchCourseBeginDate

      void matchCourseBeginDate(DateTime from, DateTime to, boolean match)
      Matches course entries whose course begin date falls within the given range inclusive.
      Parameters:
      from - starting date
      to - ending date
      match - true for a positive match, false for a negative match
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - from or to is null
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyCourseBeginDate

      void matchAnyCourseBeginDate(boolean match)
      Matches course entries that have any course begin date.
      Parameters:
      match - true to match course entries with any begin date, false to match course entries with no begin date
      Compliance:
      mandatory - This method must be implemented.

    • clearCourseBeginDateTerms

      void clearCourseBeginDateTerms()
      Clears the course begin date terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchCourseEndDate

      void matchCourseEndDate(DateTime from, DateTime to, boolean match)
      Matches course entries whose course end date falls within the given range inclusive.
      Parameters:
      from - starting date
      to - ending date
      match - true for a positive match, false for a negative match
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - from or to is null
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyCourseEndDate

      void matchAnyCourseEndDate(boolean match)
      Matches course entries that have any course end date.
      Parameters:
      match - true to match course entries with any end date, false to match course entries with no end date
      Compliance:
      mandatory - This method must be implemented.

    • clearCourseEndDateTerms

      void clearCourseEndDateTerms()
      Clears the course end date terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchComplete

      void matchComplete(boolean match)
      Matches completed courses.
      Parameters:
      match - true if a positive match, false for a negative match
      Compliance:
      mandatory - This method must be implemented.

    • clearCompleteTerms

      void clearCompleteTerms()
      Clears the complete terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchCreditScaleId

      void matchCreditScaleId(Id gradeSystemId, boolean match)
      Matches a credit scale Id .
      Parameters:
      gradeSystemId - a grade system Id
      match - true if a positive match, false for a negative match
      Throws:
      NullArgumentException - gradeSystemId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearCreditScaleIdTerms

      void clearCreditScaleIdTerms()
      Clears the grade system Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsCreditScaleQuery

      boolean supportsCreditScaleQuery()
      Tests if a GradeSystemQuery is available.
      Returns:
      true if a grade system query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getCreditScaleQuery

      GradeSystemQuery getCreditScaleQuery()
      Gets the query for a grade system. Multiple retrievals produce a nested OR term.
      Returns:
      a grade system query
      Throws:
      UnimplementedException - supportsCreditScaleQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCreditScaleQuery()} is {@code true} .

    • matchAnyCreditScale

      void matchAnyCreditScale(boolean match)
      Matches entries that have any credit scale.
      Parameters:
      match - true to match entries with any credit scale, false to match entries with no credit scale
      Compliance:
      mandatory - This method must be implemented.

    • clearCreditScaleTerms

      void clearCreditScaleTerms()
      Clears the credit scale terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchCreditsEarned

      void matchCreditsEarned(BigDecimal from, BigDecimal to, boolean match)
      Matches earned credits between the given range inclusive.
      Parameters:
      from - starting value
      to - ending value
      match - true if a positive match, false for a negative match
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - from or to is null
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyCreditsEarned

      void matchAnyCreditsEarned(boolean match)
      Matches entries that have any earned credits.
      Parameters:
      match - true to match entries with any earned credits, false to match entries with no earned credits
      Compliance:
      mandatory - This method must be implemented.

    • clearCreditsEarnedTerms

      void clearCreditsEarnedTerms()
      Clears the earned credits terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchGradeId

      void matchGradeId(Id gradeId, boolean match)
      Matches a grade Id .
      Parameters:
      gradeId - a grade Id
      match - true if a positive match, false for a negative match
      Throws:
      NullArgumentException - gradeId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearGradeIdTerms

      void clearGradeIdTerms()
      Clears the grade Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsGradeQuery

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

    • getGradeQuery

      GradeQuery getGradeQuery()
      Gets the query for a grade. Multiple retrievals produce a nested OR term.
      Returns:
      a grade system query
      Throws:
      UnimplementedException - supportsGradeQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsGradeQuery()} is {@code true} .

    • matchAnyGrade

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

    • clearGradeTerms

      void clearGradeTerms()
      Clears the grade terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchScoreScaleId

      void matchScoreScaleId(Id gradeSystemId, boolean match)
      Matches a score scale Id .
      Parameters:
      gradeSystemId - a grade system Id
      match - true if a positive match, false for a negative match
      Throws:
      NullArgumentException - gradeSystemId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearScoreScaleIdTerms

      void clearScoreScaleIdTerms()
      Clears the grade system Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsScoreScaleQuery

      boolean supportsScoreScaleQuery()
      Tests if a GradeSystemQuery is available.
      Returns:
      true if a grade system query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getScoreScaleQuery

      GradeSystemQuery getScoreScaleQuery()
      Gets the query for a grade system. Multiple retrievals produce a nested OR term.
      Returns:
      a grade system query
      Throws:
      UnimplementedException - supportsScoreScaleQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsScoreScaleQuery()} is {@code true} .

    • matchAnyScoreScale

      void matchAnyScoreScale(boolean match)
      Matches entries that have any score scale.
      Parameters:
      match - true to match entries with any score scale, false to match entries with no score scale
      Compliance:
      mandatory - This method must be implemented.

    • clearScoreScaleTerms

      void clearScoreScaleTerms()
      Clears the score scale terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchScore

      void matchScore(BigDecimal from, BigDecimal to, boolean match)
      Matches scores between the given range inclusive.
      Parameters:
      from - starting value
      to - ending value
      match - true if a positive match, false for a negative match
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - from or to is null
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyScore

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

    • clearScoreTerms

      void clearScoreTerms()
      Clears the score terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchRegistrationId

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

    • clearRegistrationIdTerms

      void clearRegistrationIdTerms()
      Clears the registration Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsRegistrationQuery

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

    • getRegistrationQuery

      RegistrationQuery getRegistrationQuery()
      Gets the query for a registration entry. Multiple retrievals produce a nested OR term.
      Returns:
      a registration query
      Throws:
      UnimplementedException - supportsRegistrationQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRegistrationQuery()} is {@code true} .

    • matchAnyRegistration

      void matchAnyRegistration(boolean match)
      Matches entries that have any registration.
      Parameters:
      match - true to match enries with any registration, false to match enries with no registration
      Compliance:
      mandatory - This method must be implemented.

    • clearRegistrationTerms

      void clearRegistrationTerms()
      Clears the registration terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchCourseCatalogId

      void matchCourseCatalogId(Id courseCatalogId, boolean match)
      Sets the course catalog Id for this query to match entries assigned to course catalogs.
      Parameters:
      courseCatalogId - the course catalog Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - courseCatalogId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearCourseCatalogIdTerms

      void clearCourseCatalogIdTerms()
      Clears the course catalog Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsCourseCatalogQuery

      boolean supportsCourseCatalogQuery()
      Tests if a CourseCatalogQuery is available.
      Returns:
      true if a course catalog query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getCourseCatalogQuery

      CourseCatalogQuery getCourseCatalogQuery()
      Gets the query for a course catalog. Multiple retrievals produce a nested OR term.
      Returns:
      the course catalog query
      Throws:
      UnimplementedException - supportsCourseCatalogQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCourseCatalogQuery()} is {@code true} .

    • clearCourseCatalogTerms

      void clearCourseCatalogTerms()
      Clears the course catalog terms.
      Compliance:
      mandatory - This method must be implemented.

    • getCourseEntryQueryRecord

      CourseEntryQueryRecord getCourseEntryQueryRecord(Type courseEntryRecordType) throws OperationFailedException
      Gets the course entry query 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 record
      Throws:
      NullArgumentException - courseEntryRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(courseEntryRecordType) is false
      Compliance:
      mandatory - This method must be implemented.