OSID - osid.grading.GradeQuery Service Interface Definition

Interface	osid.grading.GradeQuery
Implements	`osid.OsidObjectQuery`
Implements	`osid.OsidSubjugateableQuery`
Description	This is the query for searching gradings. Each method match request produces an `AND` term while multiple invocations of a method produces a nested `OR.`
Method	matchGradeSystemId
Description	Sets the grade system `Id` for this query.
Parameters	`osid.id.Id`	`gradeSystemId`	a grade system `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for negative match
Errors	NULL_ARGUMENT		`gradeSystemId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearGradeSystemIdTerms
Description	Clears the grade system `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsGradeSystemQuery
Description	Tests if a `GradeSystemQuery` is available for querying grade systems.
Return	`boolean`		`true` if a grade system query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getGradeSystemQuery
Description	Gets the query for a grade system. Multiple retrievals produce a nested `OR` term.
Return	`osid.grading.GradeSystemQuery`		the grade system query
Errors	UNIMPLEMENTED		`supportsGradeSystemQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsGradeSystemQuery()` is `true.`
Method	clearGradeSystemTerms
Description	Clears the grade system terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchInputScoreStartRange
Description	Matches grades with the start input score inclusive.
Parameters	`decimal`	`start`	start of range
	`decimal`	`end`	end of range
	`boolean`	`match`	`true` for a positive match, `false` for negative match
Errors	INVALID_ARGUMENT		`start` is greater than `end`
Compliance	`mandatory`		This method must be implemented.
Method	clearInputScoreStartRangeTerms
Description	Clears the nput score start range terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchInputScoreEndRange
Description	Matches grades with the end input score inclusive.
Parameters	`decimal`	`start`	start of range
	`decimal`	`end`	end of range
	`boolean`	`match`	`true` for a positive match, `false` for negative match
Errors	INVALID_ARGUMENT		`start` is greater than `end`
Compliance	`mandatory`		This method must be implemented.
Method	clearInputScoreEndRangeTerms
Description	Clears the nput score start range terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchInputScore
Description	Matches grades with the input score range contained within the given range inclusive.
Parameters	`decimal`	`start`	start of range
	`decimal`	`end`	end of range
	`boolean`	`match`	`true` for a positive match, `false` for negative match
Errors	INVALID_ARGUMENT		`start` is greater than `end`
Compliance	`mandatory`		This method must be implemented.
Method	clearInputScoreTerms
Description	Clears the input score start range terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchOutputScore
Description	Matches grades with the output score contained within the given range inclusive.
Parameters	`decimal`	`start`	start of range
	`decimal`	`end`	end of range
	`boolean`	`match`	`true` for a positive match, `false` for negative match
Errors	INVALID_ARGUMENT		`start` is greater than `end`
Compliance	`mandatory`		This method must be implemented.
Method	clearOutputScoreTerms
Description	Clears the output score terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchGradeEntryId
Description	Sets the grade entry `Id` for this query.
Parameters	`osid.id.Id`	`gradeEntryId`	a grade entry `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for negative match
Errors	NULL_ARGUMENT		`gradeEntryId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearGradeEntryIdTerms
Description	Clears the grade entry `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsGradeEntryQuery
Description	Tests if a `GradeEntryQuery` is available for querying grade entries.
Return	`boolean`		`true` if a grade entry query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getGradeEntryQuery
Description	Gets the query for a grade entry. Multiple retrievals produce a nested `OR` term.
Return	`osid.grading.GradeEntryQuery`		the grade entry query
Errors	UNIMPLEMENTED		`supportsGradeEntryQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsGradeEntryQuery()` is `true.`
Method	matchAnyGradeEntry
Description	Matches grades that are assigned to any grade entry.
Parameters	`boolean`	`match`	`true` to match grades used in any grade entry, `false` to match grades that are not used in any grade entries
Compliance	`mandatory`		This method must be implemented.
Method	clearGradeEntryTerms
Description	Clears the grade entry terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchGradebookId
Description	Sets the gradebook `Id` for this query.
Parameters	`osid.id.Id`	`gradebookId`	a gradebook `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for negative match
Errors	NULL_ARGUMENT		`gradebookId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearGradebookIdTerms
Description	Clears the gradebook `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsGradebookQuery
Description	Tests if a `GradebookQuery` is available .
Return	`boolean`		`true` if a gradebook query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getGradebookQuery
Description	Gets the query for a gradebook. Multiple retrievals produce a nested `OR` term.
Return	`osid.grading.GradebookQuery`		the gradebook query
Errors	UNIMPLEMENTED		`supportsGradebookQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsGradebookColumnQuery()` is `true.`
Method	clearGradebookTerms
Description	Clears the gradebook terms.
Compliance	`mandatory`		This method must be implemented.
Method	getGradeQueryRecord
Description	Gets the grade query record corresponding to the given `Grade` record `Type.` Multiple retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`gradeRecordType`	a grade record type
Return	`osid.grading.records.GradeQueryRecord`		the grade query record
Errors	NULL_ARGUMENT		`gradeRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(gradeRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.