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

Interface	osid.course.requisite.ProgramRequirementQuery
Implements	`osid.OsidRuleQuery`
Implements	`osid.OsidAggregateableQuery`
Description	This is the query for searching `ProgramRequirements`. 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 program 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	matchProgramId
Description	Sets the program `Id` for this query.
Parameters	`osid.id.Id`	`programId`	a program `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`programId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearProgramIdTerms
Description	Clears the program `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsProgramQuery
Description	Tests if a `ProgramQuery` is available.
Return	`boolean`		`true` if a program query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getProgramQuery
Description	Gets the query for a program. Multiple retrievals produce a nested `OR` term.
Return	`osid.course.program.ProgramQuery`		the query
Errors	UNIMPLEMENTED		`supportsProgramQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProgramQuery()` is `true`.
Method	matchAnyProgram
Description	Matches program requirements that have any program.
Parameters	`boolean`	`match`	`true` to match, `false` to match none
Compliance	`mandatory`		This method must be implemented.
Method	clearProgramTerms
Description	Clears the program terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchIncludeEquivalentUnits
Description	Matches program requirements that include equivalent programs.
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 program requirements that require a minimum number of programs.
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 program 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 program 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 program requirements that have a target program 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 program requirements with a target set program 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 program 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	matchRequiresCompletion
Description	Matches program 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 program 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	matchHasMinimumGPA
Description	Matches program requirements that require a minimum GPA.
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	clearHasMinimumGPATerms
Description	Clears the has minimum gpa terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchMinimumGPASystemId
Description	Sets the minimum gpa system `Id` for this query.
Parameters	`osid.id.Id`	`minimumGPASystemId`	a minimum gpa system `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`minimumGPASystemId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearMinimumGPASystemIdTerms
Description	Clears the minimum gpa system `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyMinimumGPASystem
Description	Matches program requirements with any minimum GPA system.
Parameters	`boolean`	`match`	`true` to match, `false` to match none
Compliance	`mandatory`		This method must be implemented.
Method	clearMinimumGPASystemTerms
Description	Clears the minimum gpa system terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchMinimumGPA
Description	Matches program requirements with a minimum GPA 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	matchAnyMinimumGPA
Description	Matches program requirements with any minimum GPA.
Parameters	`boolean`	`match`	`true` to match, `false` to match none
Compliance	`mandatory`		This method must be implemented.
Method	clearMinimumGPATerms
Description	Clears the minimum gpa terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchHasMinimumEarnedCredits
Description	Matches program 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 program 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 program 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	getProgramRequirementQueryRecord
Description	Gets the query record corresponding to the given `ProgramRequirement` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`programRequirementQueryRecordType`	a ProgramRequirement record type
Return	`osid.course.requisite.records.ProgramRequirementQueryRecord`		the query record
Errors	NULL_ARGUMENT		`programRequirementQueryRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(programRequirementQueryRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.