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

Interface	osid.course.requisite.AssessmentRequirementQuery
Implements	`osid.OsidRuleQuery`
Implements	`osid.OsidAggregateableQuery`
Description	This is the query for searching `AssessmentRequirements`. 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 assessment 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	matchAssessmentId
Description	Sets the assessment `Id` for this query.
Parameters	`osid.id.Id`	`assessmentId`	an assessment `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`assessmentId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAssessmentIdTerms
Description	Clears the assessment `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAssessmentQuery
Description	Tests if a `AssessmentQuery` is available.
Return	`boolean`		`true` if an assessment query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAssessmentQuery
Description	Gets the query for an assessment. Multiple retrievals produce a nested `OR` term.
Return	`osid.assessment.AssessmentQuery`		the query
Errors	UNIMPLEMENTED		`supportsAssessmentQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAssessmentQuery()` is `true`.
Method	matchAnyAssessment
Description	Matches assessment requirements that have any assessment.
Parameters	`boolean`	`match`	`true` to match, `false` to match none
Compliance	`mandatory`		This method must be implemented.
Method	clearAssessmentTerms
Description	Clears the assessment terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchIncludeEquivalentUnits
Description	Matches assessment requirements that include equivalent assessments.
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 assessment requirements that require a minimum number of assessments.
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 assessment 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 assessment 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	matchHasTargetNumberForSet
Description	Matches assessment requirements that have a target assessment 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 assessment requirements with a target set assessment 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 assessment 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	matchHasTimeframe
Description	Matches assessment 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 assessment 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 assessment 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 assessment 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 assessment 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 assessment 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 assessment 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	getAssessmentRequirementQueryRecord
Description	Gets the query record corresponding to the given `AssessmentRequirement` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`assessmentRequirementQueryRecordType`	a AssessmentRequirement record type
Return	`osid.course.requisite.records.AssessmentRequirementQueryRecord`		the query record
Errors	NULL_ARGUMENT		`assessmentRequirementQueryRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(assessmentRequirementQueryRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.