OSID - osid.offering.ResultQuery Service Interface Definition

Interface	osid.offering.ResultQuery
Implements	`osid.OsidObjectQuery`
	`osid.OsidTemporalQuery`
	`osid.OsidSubjugateableQuery`
Used By	`osid.offering.CatalogueQuery`
	`osid.offering.ResultQuerySession`
	`osid.offering.ResultSearchSession`
	`osid.offering.ResultSmartCatalogueSession`
Description	This is the query for searching results. Each method specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchParticipantId
Description	Sets a participant `Id`.
Parameters	`osid.id.Id`	`participantId`	a participant `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`participantId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearParticipantIdTerms
Description	Clears all participant `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsParticipantQuery
Description	Tests if a `ParticipantUnitQuery` is available.
Return	`boolean`		`true` if a participant query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getParticipantQuery
Description	Gets the query for a participant query. Multiple retrievals produce a nested `OR` term.
Return	`osid.offering.ParticipantQuery`		the participant query
Errors	UNIMPLEMENTED		`supportsParticipantQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsParticipantQuery()` is `true`.
Method	clearParticipantTerms
Description	Clears all participant terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchGradeId
Description	Sets a grade `Id`.
Parameters	`osid.id.Id`	`gradeId`	a grade `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`gradeId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearGradeIdTerms
Description	Clears all grade `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsGradeQuery
Description	Tests if a `GradetQuery` is available.
Return	`boolean`		`true` if a grade query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getGradeQuery
Description	Gets the query for a grade query. Multiple retrievals produce a nested `OR` term.
Return	`osid.grading.GradeQuery`		the grade query
Errors	UNIMPLEMENTED		`supportsGradeQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsGradeQuery()` is `true`.
Method	matchAnyGrade
Description	Matches results with any grade.
Parameters	`boolean`	`match`	`true` to match results with any grade, `false` to match results with no grade
Compliance	`mandatory`		This method must be implemented.
Method	clearGradeTerms
Description	Clears all grade terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchValue
Description	Matches a value between the given range inclusive.
Parameters	`decimal`	`from`	a starting range
	`decimal`	`to`	an ending range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`from` is greater than `to`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyValue
Description	Matches results with any value.
Parameters	`boolean`	`match`	`true` to match results with any value, `false` to match results with no value
Compliance	`mandatory`		This method must be implemented.
Method	clearValueTerms
Description	Clears all value terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCatalogueId
Description	Sets the catalogue `Id` for this query to match results assigned to catalogues.
Parameters	`osid.id.Id`	`catalogueId`	a catalogue `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`catalogueId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCatalogueIdTerms
Description	Clears all catalogue `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsCatalogueQuery
Description	Tests if a `CatalogueQuery` is available.
Return	`boolean`		`true` if a catalogue query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCatalogueQuery
Description	Gets the query for a catalogue query. Multiple retrievals produce a nested `OR` term.
Return	`osid.offering.CatalogueQuery`		the catalogue query
Errors	UNIMPLEMENTED		`supportsCatalogueQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCatalogueQuery()` is `true`.
Method	clearCatalogueTerms
Description	Clears all catalogue terms.
Compliance	`mandatory`		This method must be implemented.
Method	getResultQueryRecord
Description	Gets the result query record corresponding to the given `Result` record `Type` .Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`resultRecordType`	a result record type
Return	`osid.offering.records.ResultQueryRecord`		the result query record
Errors	NULL_ARGUMENT		`resultRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(resultRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.