Interface CourseRequirementQuery

All Superinterfaces:
Extensible, OsidAggregateableQuery, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidOperableQuery, OsidQuery, OsidRuleQuery, Suppliable
public interface CourseRequirementQuery extends OsidRuleQuery, OsidAggregateableQuery

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

  • Method Details

    • matchAltRequisiteId

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

    • clearAltRequisiteIdTerms

      void clearAltRequisiteIdTerms()
      Clears the alt requisite Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsAltRequisiteQuery

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

    • getAltRequisiteQuery

      RequisiteQuery getAltRequisiteQuery()
      Gets the query for an alternate requisite. Multiple retrievals produce a nested OR term.
      Returns:
      the query
      Throws:
      UnimplementedException - supportsAltRequisiteQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsAltRequisiteQuery()} is {@code true} .

    • matchAnyAltRequisite

      void matchAnyAltRequisite(boolean match)
      Matches course requirements that have any alternate requisite.
      Parameters:
      match - true to match, false to match none
      Compliance:
      mandatory - This method must be implemented.

    • clearAltRequisiteTerms

      void clearAltRequisiteTerms()
      Clears the alternate requisite terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchCourseId

      void matchCourseId(Id courseId, boolean match)
      Sets the course Id for this query.
      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. Multiple retrievals produce a nested OR term.
      Returns:
      the query
      Throws:
      UnimplementedException - supportsCourseQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCourseQuery()} is {@code true} .

    • matchAnyCourse

      void matchAnyCourse(boolean match)
      Matches course requirements that have any course.
      Parameters:
      match - true to match, false to match none
      Compliance:
      mandatory - This method must be implemented.

    • clearCourseTerms

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

    • matchRequiresSubjectArea

      void matchRequiresSubjectArea(boolean match)
      Matches course requirements that require any course in a subject area.
      Parameters:
      match - true for a positive match, false for a negative match
      Compliance:
      mandatory - This method must be implemented.

    • clearRequiresSubjectAreaTerms

      void clearRequiresSubjectAreaTerms()
      Clears the requires subject area terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchSubjectAreaId

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

    • clearSubjectAreaIdTerms

      void clearSubjectAreaIdTerms()
      Clears the subject area Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsSubjectAreaQuery

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

    • getSubjectAreaQuery

      SubjectQuery getSubjectAreaQuery()
      Gets the query for a subject area. Multiple retrievals produce a nested OR term.
      Returns:
      the query
      Throws:
      UnimplementedException - supportsSubjectAreaQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsSubjectAreaQuery()} is {@code true} .

    • matchAnySubjectArea

      void matchAnySubjectArea(boolean match)
      Matches course requirements that have any subject area.
      Parameters:
      match - true to match, false to match none
      Compliance:
      mandatory - This method must be implemented.

    • clearSubjectAreaTerms

      void clearSubjectAreaTerms()
      Clears the subject area terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchIncludeEquivalentUnits

      void matchIncludeEquivalentUnits(boolean match)
      Matches course requirements that include equivalent courses.
      Parameters:
      match - true for a positive match, false for a negative match
      Compliance:
      mandatory - This method must be implemented.

    • clearIncludeEquivalentUnitsTerms

      void clearIncludeEquivalentUnitsTerms()
      Clears the include equivalent units terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchRequiresMinimumNumber

      void matchRequiresMinimumNumber(boolean match)
      Matches course requirements that require a minimum number of courses.
      Parameters:
      match - true for a positive match, false for a negative match
      Compliance:
      mandatory - This method must be implemented.

    • clearRequiresMinimumNumberTerms

      void clearRequiresMinimumNumberTerms()
      Clears the requires minimum number terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchMinimumNumber

      void matchMinimumNumber(long min, long max, boolean match)
      Matches course requirements with a minimum number between the given values inclusive.
      Parameters:
      min - low number
      max - high number
      match - true for a positive match, false for a negative match
      Throws:
      InvalidArgumentException - max is less than min
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyMinimumNumber

      void matchAnyMinimumNumber(boolean match)
      Matches course requirements with any minimum number.
      Parameters:
      match - true to match, false to match none
      Compliance:
      mandatory - This method must be implemented.

    • clearMinimumNumberTerms

      void clearMinimumNumberTerms()
      Clears the minimum number terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchRequiresMinimumNonTransferNumber

      void matchRequiresMinimumNonTransferNumber(boolean match)
      Matches course requirements that require a minimum non-transfer course count.
      Parameters:
      match - true for a positive match, false for a negative match
      Compliance:
      mandatory - This method must be implemented.

    • clearRequiresMinimumNonTransferNumberTerms

      void clearRequiresMinimumNonTransferNumberTerms()
      Clears the requires minimum non-transfer number terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchMinimumNonTransferNumber

      void matchMinimumNonTransferNumber(long min, long max, boolean match)
      Matches course requirements with a minimum non-transfer course count between the given values inclusive.
      Parameters:
      min - low number
      max - high number
      match - true for a positive match, false for a negative match
      Throws:
      InvalidArgumentException - max is less than min
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyMinimumNonTransferNumber

      void matchAnyMinimumNonTransferNumber(boolean match)
      Matches course requirements with any minimum non-transfer number.
      Parameters:
      match - true to match, false to match none
      Compliance:
      mandatory - This method must be implemented.

    • clearMinimumNonTransferNumberTerms

      void clearMinimumNonTransferNumberTerms()
      Clears the minimum non-transfer number terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchHasTargetNumberForSet

      void matchHasTargetNumberForSet(boolean match)
      Matches course requirements that have a target course count for the set.
      Parameters:
      match - true for a positive match, false for a negative match
      Compliance:
      mandatory - This method must be implemented.

    • clearHasTargetNumberForSetTerms

      void clearHasTargetNumberForSetTerms()
      Clears the has target number for set terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchTargetSetNumber

      void matchTargetSetNumber(long min, long max, boolean match)
      Matches course requirements with a target set course count between the given values inclusive.
      Parameters:
      min - low number
      max - high number
      match - true for a positive match, false for a negative match
      Throws:
      InvalidArgumentException - max is less than min
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyTargetSetNumber

      void matchAnyTargetSetNumber(boolean match)
      Matches course requirements with any target set number.
      Parameters:
      match - true to match, false to match none
      Compliance:
      mandatory - This method must be implemented.

    • clearTargetSetNumberTerms

      void clearTargetSetNumberTerms()
      Clears the target set number terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchRequiresMinimumCredits

      void matchRequiresMinimumCredits(boolean match)
      Matches course requirements that require a minimum number of credits.
      Parameters:
      match - true for a positive match, false for a negative match
      Compliance:
      mandatory - This method must be implemented.

    • clearRequiresMinimumCreditsTerms

      void clearRequiresMinimumCreditsTerms()
      Clears the requires minimum credits terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchCreditScaleId

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

    • clearCreditScaleIdTerms

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

    • matchAnyCreditScale

      void matchAnyCreditScale(boolean match)
      Matches course requirements with any credit scale.
      Parameters:
      match - true to match, false to match none
      Compliance:
      mandatory - This method must be implemented.

    • clearCreditScaleTerms

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

    • matchMinimumCredits

      void matchMinimumCredits(BigDecimal min, BigDecimal max, boolean match)
      Matches course requirements with a minimum credits value between the given values inclusive.
      Parameters:
      min - low value
      max - high value
      match - true for a positive match, false for a negative match
      Throws:
      InvalidArgumentException - max is less than min
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyMinimumCredits

      void matchAnyMinimumCredits(boolean match)
      Matches course requirements with any minimum credits.
      Parameters:
      match - true to match, false to match none
      Compliance:
      mandatory - This method must be implemented.

    • clearMinimumCreditsTerms

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

    • matchRequiresMinimumNonTransferCredits

      void matchRequiresMinimumNonTransferCredits(boolean match)
      Matches course requirements that require a minimum non-transfer credit count.
      Parameters:
      match - true for a positive match, false for a negative match
      Compliance:
      mandatory - This method must be implemented.

    • clearRequiresMinimumNonTransferCreditsTerms

      void clearRequiresMinimumNonTransferCreditsTerms()
      Clears the requires minimum non-transfer credits terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchNonTransferCredits

      void matchNonTransferCredits(BigDecimal min, BigDecimal max, boolean match)
      Matches course requirements with a non-transfer credits value between the given values inclusive.
      Parameters:
      min - low value
      max - high value
      match - true for a positive match, false for a negative match
      Throws:
      InvalidArgumentException - max is less than min
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyNonTransferCredits

      void matchAnyNonTransferCredits(boolean match)
      Matches course requirements with any non-transfer credits.
      Parameters:
      match - true to match, false to match none
      Compliance:
      mandatory - This method must be implemented.

    • clearNonTransferCreditsTerms

      void clearNonTransferCreditsTerms()
      Clears the non-transfer credits terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchHasTargetCreditsForSet

      void matchHasTargetCreditsForSet(boolean match)
      Matches course requirements that have a target credit count for the set.
      Parameters:
      match - true for a positive match, false for a negative match
      Compliance:
      mandatory - This method must be implemented.

    • clearHasTargetCreditsForSetTerms

      void clearHasTargetCreditsForSetTerms()
      Clears the has target credits for set terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchTargetSetCredits

      void matchTargetSetCredits(BigDecimal min, BigDecimal max, boolean match)
      Matches course requirements with a target set credit value between the given values inclusive.
      Parameters:
      min - low value
      max - high value
      match - true for a positive match, false for a negative match
      Throws:
      InvalidArgumentException - max is less than min
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyTargetSetCredits

      void matchAnyTargetSetCredits(boolean match)
      Matches course requirements with any target set credits.
      Parameters:
      match - true to match, false to match none
      Compliance:
      mandatory - This method must be implemented.

    • clearTargetSetCreditsTerms

      void clearTargetSetCreditsTerms()
      Clears the target set credits terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchRequiresCompletion

      void matchRequiresCompletion(boolean match)
      Matches course requirements that require completion with a passing grade.
      Parameters:
      match - true for a positive match, false for a negative match
      Compliance:
      mandatory - This method must be implemented.

    • clearRequiresCompletionTerms

      void clearRequiresCompletionTerms()
      Clears the requires completion terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchHasTimeframe

      void matchHasTimeframe(boolean match)
      Matches course requirements that have a timeframe.
      Parameters:
      match - true for a positive match, false for a negative match
      Compliance:
      mandatory - This method must be implemented.

    • clearHasTimeframeTerms

      void clearHasTimeframeTerms()
      Clears the has timeframe terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchHasMinimumGrade

      void matchHasMinimumGrade(boolean match)
      Matches course requirements that require a minimum grade.
      Parameters:
      match - true for a positive match, false for a negative match
      Compliance:
      mandatory - This method must be implemented.

    • clearHasMinimumGradeTerms

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

    • matchMinimumGradeId

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

    • clearMinimumGradeIdTerms

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

    • supportsMinimumGradeQuery

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

    • getMinimumGradeQuery

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

    • matchAnyMinimumGrade

      void matchAnyMinimumGrade(boolean match)
      Matches course requirements with any minimum grade.
      Parameters:
      match - true to match, false to match none
      Compliance:
      mandatory - This method must be implemented.

    • clearMinimumGradeTerms

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

    • matchHasMinimumScore

      void matchHasMinimumScore(boolean match)
      Matches course requirements that require a minimum score.
      Parameters:
      match - true for a positive match, false for a negative match
      Compliance:
      mandatory - This method must be implemented.

    • clearHasMinimumScoreTerms

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

    • matchMinimumScoreSystemId

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

    • clearMinimumScoreSystemIdTerms

      void clearMinimumScoreSystemIdTerms()
      Clears the minimum score system Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyMinimumScoreSystem

      void matchAnyMinimumScoreSystem(boolean match)
      Matches course requirements with any minimum score system.
      Parameters:
      match - true to match, false to match none
      Compliance:
      mandatory - This method must be implemented.

    • clearMinimumScoreSystemTerms

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

    • matchMinimumScore

      void matchMinimumScore(BigDecimal min, BigDecimal max, boolean match)
      Matches course requirements with a minimum score between the given values inclusive.
      Parameters:
      min - low value
      max - high value
      match - true for a positive match, false for a negative match
      Throws:
      InvalidArgumentException - max is less than min
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyMinimumScore

      void matchAnyMinimumScore(boolean match)
      Matches course requirements with any minimum score.
      Parameters:
      match - true to match, false to match none
      Compliance:
      mandatory - This method must be implemented.

    • clearMinimumScoreTerms

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

    • matchHasMinimumEarnedCredits

      void matchHasMinimumEarnedCredits(boolean match)
      Matches course requirements that require a minimum earned credit count.
      Parameters:
      match - true for a positive match, false for a negative match
      Compliance:
      mandatory - This method must be implemented.

    • clearHasMinimumEarnedCreditsTerms

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

    • matchMinimumEarnedCredits

      void matchMinimumEarnedCredits(BigDecimal min, BigDecimal max, boolean match)
      Matches course requirements with a minimum earned credits value between the given values inclusive.
      Parameters:
      min - low value
      max - high value
      match - true for a positive match, false for a negative match
      Throws:
      InvalidArgumentException - max is less than min
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyMinimumEarnedCredits

      void matchAnyMinimumEarnedCredits(boolean match)
      Matches course requirements with any minimum earned credits.
      Parameters:
      match - true to match, false to match none
      Compliance:
      mandatory - This method must be implemented.

    • clearMinimumEarnedCreditsTerms

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

    • getCourseRequirementQueryRecord

      CourseRequirementQueryRecord getCourseRequirementQueryRecord(Type courseRequirementQueryRecordType) throws OperationFailedException
      Gets the course requirement query record corresponding to the given CourseRequirement record Type . Multiple record retrievals produce a nested OR term.
      Parameters:
      courseRequirementQueryRecordType - a course requirement record type
      Returns:
      the course requirement query record
      Throws:
      NullArgumentException - courseRequirementQueryRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(courseRequirementQueryRecordType) is false
      Compliance:
      mandatory - This method must be implemented.