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

Interface	osid.course.requisite.CredentialRequirementQuery
Implements	`osid.OsidRuleQuery`
Implements	`osid.OsidAggregateableQuery`
Description	This is the query for searching `CredentialRequirements`. 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 credential 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	matchCredentialId
Description	Sets the credential `Id` for this query.
Parameters	`osid.id.Id`	`credentialId`	a credential `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`credentialId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCredentialIdTerms
Description	Clears the credential `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsCredentialQuery
Description	Tests if a `CredentialQuery` is available.
Return	`boolean`		`true` if a credential query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCredentialQuery
Description	Gets the query for a credential. Multiple retrievals produce a nested `OR` term.
Return	`osid.course.program.CredentialQuery`		the query
Errors	UNIMPLEMENTED		`supportsCredentialQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCredentialQuery()` is `true`.
Method	matchAnyCredential
Description	Matches credential requirements that have any credential.
Parameters	`boolean`	`match`	`true` to match, `false` to match none
Compliance	`mandatory`		This method must be implemented.
Method	clearCredentialTerms
Description	Clears the credential terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchRequiresMinimumNumber
Description	Matches credential requirements that require a minimum number of credentials.
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 credential 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 credential 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 credential requirements that have a target credential 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 credential requirements with a target set credential 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 credential 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 credential 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	getCredentialRequirementQueryRecord
Description	Gets the query record corresponding to the given `CredentialRequirement` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`credentialRequirementQueryRecordType`	a CredentialRequirement record type
Return	`osid.course.requisite.records.CredentialRequirementQueryRecord`		the query record
Errors	NULL_ARGUMENT		`credentialRequirementQueryRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(credentialRequirementQueryRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.