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

Interface	osid.course.requisite.LearningObjectiveRequirementQuery
Implements	`osid.OsidRuleQuery`
Implements	`osid.OsidAggregateableQuery`
Description	This is the query for searching `LearningObjectiveRequirements`. 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 learning objective 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	matchLearningObjectiveId
Description	Sets the learning objective `Id` for this query.
Parameters	`osid.id.Id`	`learningObjectiveId`	a learning objective `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`learningObjectiveId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearLearningObjectiveIdTerms
Description	Clears the learning objective `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsLearningObjectiveQuery
Description	Tests if a `ObjectiveQuery` is available.
Return	`boolean`		`true` if a learning objective query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getLearningObjectiveQuery
Description	Gets the query for a learning objective. Multiple retrievals produce a nested `OR` term.
Return	`osid.learning.ObjectiveQuery`		the query
Errors	UNIMPLEMENTED		`supportsLearningObjectiveQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLearningObjectiveQuery()` is `true`.
Method	matchAnyLearningObjective
Description	Matches learning objective requirements that have any learning objective.
Parameters	`boolean`	`match`	`true` to match, `false` to match none
Compliance	`mandatory`		This method must be implemented.
Method	clearLearningObjectiveTerms
Description	Clears the learning objective terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchIncludeEquivalentUnits
Description	Matches learning objective requirements that include equivalent learning objectives.
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 learning objective requirements that require a minimum number of learning objectives.
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 learning objective 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 learning objective 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 learning objective requirements that have a target learning objective 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 learning objective requirements with a target set learning objective 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 learning objective 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	matchHasMinimumProficiency
Description	Matches learning objective requirements that require a minimum proficiency.
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	clearHasMinimumProficiencyTerms
Description	Clears the has minimum proficiency terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchMinimumProficiencyId
Description	Sets the minimum proficiency `Id` for this query.
Parameters	`osid.id.Id`	`minimumProficiencyId`	a minimum proficiency `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`minimumProficiencyId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearMinimumProficiencyIdTerms
Description	Clears the minimum proficiency `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsMinimumProficiencyQuery
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	getMinimumProficiencyQuery
Description	Gets the query for a minimum proficiency. Multiple retrievals produce a nested `OR` term.
Return	`osid.grading.GradeQuery`		the query
Errors	UNIMPLEMENTED		`supportsMinimumProficiencyQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsMinimumProficiencyQuery()` is `true`.
Method	matchAnyMinimumProficiency
Description	Matches learning objective requirements with any minimum proficiency.
Parameters	`boolean`	`match`	`true` to match, `false` to match none
Compliance	`mandatory`		This method must be implemented.
Method	clearMinimumProficiencyTerms
Description	Clears the minimum proficiency terms.
Compliance	`mandatory`		This method must be implemented.
Method	getLearningObjectiveRequirementQueryRecord
Description	Gets the query record corresponding to the given `LearningObjectiveRequirement` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`learningObjectiveRequirementQueryRecordType`	a LearningObjectiveRequirement record type
Return	`osid.course.requisite.records.LearningObjectiveRequirementQueryRecord`		the query record
Errors	NULL_ARGUMENT		`learningObjectiveRequirementQueryRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(learningObjectiveRequirementQueryRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.