OSID - osid.course.requisite.CourseRequirementQuery Service Interface Definition

Interface	osid.course.requisite.CourseRequirementQuery
Implements	`osid.OsidRuleQuery`
Implements	`osid.OsidAggregateableQuery`
Description	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	matchAltRequisiteId
Description	Sets the alt requisite `Id` for this query.
Parameters	`osid.id.Id`	`altRequisiteId`	an alt requisite `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`altRequisiteId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAltRequisiteIdTerms
Description	Clears the alt requisite `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAltRequisiteQuery
Description	Tests if a `RequisiteQuery` is available.
Return	`boolean`		`true` if a requisite query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAltRequisiteQuery
Description	Gets the query for an alternate requisite. Multiple retrievals produce a nested `OR` term.
Return	`osid.course.requisite.RequisiteQuery`		the query
Errors	UNIMPLEMENTED		`supportsAltRequisiteQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAltRequisiteQuery()` is `true`.
Method	matchAnyAltRequisite
Description	Matches course requirements that have any alternate requisite.
Parameters	`boolean`	`match`	`true` to match, `false` to match none
Compliance	`mandatory`		This method must be implemented.
Method	clearAltRequisiteTerms
Description	Clears the alternate requisite terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCourseId
Description	Sets the course `Id` for this query.
Parameters	`osid.id.Id`	`courseId`	a course `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`courseId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCourseIdTerms
Description	Clears the course `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseQuery
Description	Tests if a `CourseQuery` is available.
Return	`boolean`		`true` if a course query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCourseQuery
Description	Gets the query for a course. Multiple retrievals produce a nested `OR` term.
Return	`osid.course.CourseQuery`		the query
Errors	UNIMPLEMENTED		`supportsCourseQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCourseQuery()` is `true`.
Method	matchAnyCourse
Description	Matches course requirements that have any course.
Parameters	`boolean`	`match`	`true` to match, `false` to match none
Compliance	`mandatory`		This method must be implemented.
Method	clearCourseTerms
Description	Clears the course terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchRequiresSubjectArea
Description	Matches course requirements that require any course in a subject area.
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	clearRequiresSubjectAreaTerms
Description	Clears the requires subject area terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchSubjectAreaId
Description	Sets the subject area `Id` for this query.
Parameters	`osid.id.Id`	`subjectAreaId`	a subject area `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`subjectAreaId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearSubjectAreaIdTerms
Description	Clears the subject area `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsSubjectAreaQuery
Description	Tests if a `SubjectQuery` is available.
Return	`boolean`		`true` if a subject query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getSubjectAreaQuery
Description	Gets the query for a subject area. Multiple retrievals produce a nested `OR` term.
Return	`osid.ontology.SubjectQuery`		the query
Errors	UNIMPLEMENTED		`supportsSubjectAreaQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSubjectAreaQuery()` is `true`.
Method	matchAnySubjectArea
Description	Matches course requirements that have any subject area.
Parameters	`boolean`	`match`	`true` to match, `false` to match none
Compliance	`mandatory`		This method must be implemented.
Method	clearSubjectAreaTerms
Description	Clears the subject area terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchIncludeEquivalentUnits
Description	Matches course requirements that include equivalent courses.
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	clearIncludeEquivalentUnitsTerms
Description	Clears the include equivalent units terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchRequiresMinimumNumber
Description	Matches course requirements that require a minimum number of courses.
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	clearRequiresMinimumNumberTerms
Description	Clears the requires minimum number terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchMinimumNumber
Description	Matches course requirements with a minimum number between the given values inclusive.
Parameters	`cardinal`	`min`	low number
	`cardinal`	`max`	high number
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`max` is less than `min`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyMinimumNumber
Description	Matches course requirements with any minimum number.
Parameters	`boolean`	`match`	`true` to match, `false` to match none
Compliance	`mandatory`		This method must be implemented.
Method	clearMinimumNumberTerms
Description	Clears the minimum number terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchRequiresMinimumNonTransferNumber
Description	Matches course requirements that require a minimum non-transfer course count.
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	clearRequiresMinimumNonTransferNumberTerms
Description	Clears the requires minimum non-transfer number terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchMinimumNonTransferNumber
Description	Matches course requirements with a minimum non-transfer course count between the given values inclusive.
Parameters	`cardinal`	`min`	low number
	`cardinal`	`max`	high number
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`max` is less than `min`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyMinimumNonTransferNumber
Description	Matches course requirements with any minimum non-transfer number.
Parameters	`boolean`	`match`	`true` to match, `false` to match none
Compliance	`mandatory`		This method must be implemented.
Method	clearMinimumNonTransferNumberTerms
Description	Clears the minimum non-transfer number terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchHasTargetNumberForSet
Description	Matches course requirements that have a target course count for the set.
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	clearHasTargetNumberForSetTerms
Description	Clears the has target number for set terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchTargetSetNumber
Description	Matches course requirements with a target set course count between the given values inclusive.
Parameters	`cardinal`	`min`	low number
	`cardinal`	`max`	high number
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`max` is less than `min`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyTargetSetNumber
Description	Matches course requirements with any target set number.
Parameters	`boolean`	`match`	`true` to match, `false` to match none
Compliance	`mandatory`		This method must be implemented.
Method	clearTargetSetNumberTerms
Description	Clears the target set number terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchRequiresMinimumCredits
Description	Matches course requirements that require a minimum number of credits.
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	clearRequiresMinimumCreditsTerms
Description	Clears the requires minimum credits terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCreditScaleId
Description	Sets the credit scale `Id` for this query.
Parameters	`osid.id.Id`	`creditScaleId`	a credit scale `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`creditScaleId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCreditScaleIdTerms
Description	Clears the credit scale `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyCreditScale
Description	Matches course requirements with any credit scale.
Parameters	`boolean`	`match`	`true` to match, `false` to match none
Compliance	`mandatory`		This method must be implemented.
Method	clearCreditScaleTerms
Description	Clears the credit scale terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchMinimumCredits
Description	Matches course requirements with a minimum credits value between the given values inclusive.
Parameters	`decimal`	`min`	low value
	`decimal`	`max`	high value
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`max` is less than `min`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyMinimumCredits
Description	Matches course requirements with any minimum credits.
Parameters	`boolean`	`match`	`true` to match, `false` to match none
Compliance	`mandatory`		This method must be implemented.
Method	clearMinimumCreditsTerms
Description	Clears the minimum credits terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchRequiresMinimumNonTransferCredits
Description	Matches course requirements that require a minimum non-transfer credit count.
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	clearRequiresMinimumNonTransferCreditsTerms
Description	Clears the requires minimum non-transfer credits terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchNonTransferCredits
Description	Matches course requirements with a non-transfer credits value between the given values inclusive.
Parameters	`decimal`	`min`	low value
	`decimal`	`max`	high value
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`max` is less than `min`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyNonTransferCredits
Description	Matches course requirements with any non-transfer credits.
Parameters	`boolean`	`match`	`true` to match, `false` to match none
Compliance	`mandatory`		This method must be implemented.
Method	clearNonTransferCreditsTerms
Description	Clears the non-transfer credits terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchHasTargetCreditsForSet
Description	Matches course requirements that have a target credit count for the set.
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	clearHasTargetCreditsForSetTerms
Description	Clears the has target credits for set terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchTargetSetCredits
Description	Matches course requirements with a target set credit value between the given values inclusive.
Parameters	`decimal`	`min`	low value
	`decimal`	`max`	high value
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`max` is less than `min`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyTargetSetCredits
Description	Matches course requirements with any target set credits.
Parameters	`boolean`	`match`	`true` to match, `false` to match none
Compliance	`mandatory`		This method must be implemented.
Method	clearTargetSetCreditsTerms
Description	Clears the target set credits terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchRequiresCompletion
Description	Matches course requirements that require completion with a passing grade.
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	clearRequiresCompletionTerms
Description	Clears the requires completion terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchHasTimeframe
Description	Matches course requirements that have a timeframe.
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	clearHasTimeframeTerms
Description	Clears the has timeframe terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchHasMinimumGrade
Description	Matches course requirements that require a minimum grade.
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	clearHasMinimumGradeTerms
Description	Clears the has minimum grade terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchMinimumGradeId
Description	Sets the minimum grade `Id` for this query.
Parameters	`osid.id.Id`	`minimumGradeId`	a minimum grade `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`minimumGradeId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearMinimumGradeIdTerms
Description	Clears the minimum grade `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsMinimumGradeQuery
Description	Tests if a `GradeQuery` is available.
Return	`boolean`		`true` if a grade query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getMinimumGradeQuery
Description	Gets the query for a minimum grade. Multiple retrievals produce a nested `OR` term.
Return	`osid.grading.GradeQuery`		the query
Errors	UNIMPLEMENTED		`supportsMinimumGradeQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsMinimumGradeQuery()` is `true`.
Method	matchAnyMinimumGrade
Description	Matches course requirements with any minimum grade.
Parameters	`boolean`	`match`	`true` to match, `false` to match none
Compliance	`mandatory`		This method must be implemented.
Method	clearMinimumGradeTerms
Description	Clears the minimum grade terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchHasMinimumScore
Description	Matches course requirements that require a minimum score.
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	clearHasMinimumScoreTerms
Description	Clears the has minimum score terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchMinimumScoreSystemId
Description	Sets the minimum score system `Id` for this query.
Parameters	`osid.id.Id`	`minimumScoreSystemId`	a minimum score system `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`minimumScoreSystemId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearMinimumScoreSystemIdTerms
Description	Clears the minimum score system `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyMinimumScoreSystem
Description	Matches course requirements with any minimum score system.
Parameters	`boolean`	`match`	`true` to match, `false` to match none
Compliance	`mandatory`		This method must be implemented.
Method	clearMinimumScoreSystemTerms
Description	Clears the minimum score system terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchMinimumScore
Description	Matches course requirements with a minimum score between the given values inclusive.
Parameters	`decimal`	`min`	low value
	`decimal`	`max`	high value
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`max` is less than `min`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyMinimumScore
Description	Matches course requirements with any minimum score.
Parameters	`boolean`	`match`	`true` to match, `false` to match none
Compliance	`mandatory`		This method must be implemented.
Method	clearMinimumScoreTerms
Description	Clears the minimum score terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchHasMinimumEarnedCredits
Description	Matches course requirements that require a minimum earned credit count.
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	clearHasMinimumEarnedCreditsTerms
Description	Clears the has minimum earned credits terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchMinimumEarnedCredits
Description	Matches course requirements with a minimum earned credits value between the given values inclusive.
Parameters	`decimal`	`min`	low value
	`decimal`	`max`	high value
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`max` is less than `min`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyMinimumEarnedCredits
Description	Matches course requirements with any minimum earned credits.
Parameters	`boolean`	`match`	`true` to match, `false` to match none
Compliance	`mandatory`		This method must be implemented.
Method	clearMinimumEarnedCreditsTerms
Description	Clears the minimum earned credits terms.
Compliance	`mandatory`		This method must be implemented.
Method	getCourseRequirementQueryRecord
Description	Gets the course requirement query record corresponding to the given `CourseRequirement` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`courseRequirementQueryRecordType`	a course requirement record type
Return	`osid.course.requisite.records.CourseRequirementQueryRecord`		the course requirement query record
Errors	NULL_ARGUMENT		`courseRequirementQueryRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(courseRequirementQueryRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.