OSID - osid.recognition.ConvocationQuery Service Interface Definition

Interface	osid.recognition.ConvocationQuery
Implements	`osid.OsidGovernatorQuery`
Description	This is the query for searching convocations. Each method specifies an `AND` term while multiple invocations of the same method produce a nested `OR.`
Method	matchAwardId
Description	Sets an award `Id.`
Parameters	`osid.id.Id`	`awardId`	an award `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`awardId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAwardIdTerms
Description	Clears the award `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAwardQuery
Description	Tests if an `AwardQuery` is available.
Return	`boolean`		`true` if an award query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAwardQuery
Description	Gets the query for an award query. Multiple retrievals produce a nested `OR` term.
Return	`osid.recognition.AwardQuery`		the award query
Errors	UNIMPLEMENTED		`supportsAwardQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAwardQuery()` is `true.`
Method	matchAnyAward
Description	Matches convocations with any award.
Parameters	`boolean`	`match`	`true` to match convocations with any award, `false` to match convocations with no awards
Compliance	`mandatory`		This method must be implemented.
Method	clearAwardTerms
Description	Clears the award terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDate
Description	Matches the date between the given dates inclusive.
Parameters	`osid.calendaring.DateTime`	`from`	starting date
	`osid.calendaring.DateTime`	`to`	ending date
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`from` is greater than `to`
Errors	NULL_ARGUMENT		`from` or `to` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyDate
Description	Matches convocations with any date.
Parameters	`boolean`	`match`	`true` to match convocations with any date, `false` to match convocations with no date
Compliance	`mandatory`		This method must be implemented.
Method	clearDateTerms
Description	Clears the date terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchTimePeriodId
Description	Sets a time period `Id.`
Parameters	`osid.id.Id`	`timePeriodId`	a time period `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`timePeriodId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearTimePeriodIdTerms
Description	Clears the time period `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsTimePeriodQuery
Description	Tests if a `TimePeriodQuery` is available.
Return	`boolean`		`true` if a time period query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getTimePeriodQuery
Description	Gets the query for a time period query. Multiple retrievals produce a nested `OR` term.
Return	`osid.calendaring.TimePeriodQuery`		the time period query
Errors	UNIMPLEMENTED		`supportsTimePeriodQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsTimePeriodQuery()` is `true.`
Method	matchAnyTimePeriod
Description	Matches any time period.
Parameters	`boolean`	`match`	`true` to match convocations with any time period, `false` to match convocations with no time period
Compliance	`mandatory`		This method must be implemented.
Method	clearTimePeriodTerms
Description	Clears the time period terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchConferralId
Description	Sets the conferral `Id` for this query.
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 convocations with any conferral.
Parameters	`boolean`	`match`	`true` to match convocations with any conferral, `false` to match convocations 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 convocations 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	getConvocationQueryRecord
Description	Gets the convocation query record corresponding to the given `Convocation` record `Type.` Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`convocationRecordType`	a convocation record type
Return	`osid.recognition.records.ConvocationQueryRecord`		the convocation query record
Errors	NULL_ARGUMENT		`convocationRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(convocationRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.