OSID - osid.recognition.AwardQuery Service Interface Definition

Interface	osid.recognition.AwardQuery
Implements	`osid.OsidObjectQuery`
Description	This is the query for searching for awards. Each method specifies an `AND` term while multiple invocations of the same method produce a nested `OR.`
Method	matchConferralId
Description	Sets the conferral `Id` for this query to match conferrals assigned to awards.
Parameters	`osid.id.Id`	`conferralId`	a conferral `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`conferralId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearConferralIdTerms
Description	Clears the conferral `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsConferralQuery
Description	Tests if a conferral query is available.
Return	`boolean`		`true` if a conferral query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getConferralQuery
Description	Gets the query for an award.
Return	`osid.recognition.ConferralQuery`		the conferral query
Errors	UNIMPLEMENTED		`supportsConferralQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsConferralQuery()` is `true.`
Method	matchAnyConferral
Description	Matches awards with any conferral.
Parameters	`boolean`	`match`	`true` to match awards with any conferral, `false` to match awards with no conferrals
Compliance	`mandatory`		This method must be implemented.
Method	clearConferralTerms
Description	Clears the conferral terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAcademyId
Description	Sets the award `Id` for this query to match conferrals assigned to academies.
Parameters	`osid.id.Id`	`academyId`	an academy `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`academyId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAcademyIdTerms
Description	Clears the academy `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAcademyQuery
Description	Tests if an `AcademyQuery` is available.
Return	`boolean`		`true` if an academy query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAcademyQuery
Description	Gets the query for an academy query. Multiple retrievals produce a nested `OR` term.
Return	`osid.recognition.AcademyQuery`		the academy query
Errors	UNIMPLEMENTED		`supportsAcademyQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAcademyQuery()` is `true.`
Method	clearAcademyTerms
Description	Clears the academy terms.
Compliance	`mandatory`		This method must be implemented.
Method	getAwardQueryRecord
Description	Gets the award query record corresponding to the given `Award` record `Type.` Multiple record retrievals produce a nested boolean `OR` term.
Parameters	`osid.type.Type`	`awardRecordType`	an award record type
Return	`osid.recognition.records.AwardQueryRecord`		the award query record
Errors	NULL_ARGUMENT		`awardRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(awardRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.