OSID - osid.grading.GradebookQuery Service Interface Definition

Interface	osid.grading.GradebookQuery
Implements	`osid.OsidCatalogQuery`
Used By	`osid.grading.GradeEntryQuery`
	`osid.grading.GradeQuery`
	`osid.grading.GradeSystemQuery`
	`osid.grading.GradebookColumnQuery`
	`osid.grading.GradebookColumnSummaryQuery`
	`osid.grading.GradebookQuery`
	`osid.grading.GradebookQuerySession`
	`osid.grading.GradebookSearchSession`
Description	This is the query for searching gradebooks. Each method specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchGradeId
Description	Sets the grade `Id` for this query.
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 the grade `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsGradeQuery
Description	Tests if a `GradeQuery` 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. 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 gradebooks that have any grade.
Parameters	`boolean`	`match`	`true` to match gradebooks with any grade, `false` to match gradebooks with no grade
Compliance	`mandatory`		This method must be implemented.
Method	clearGradeTerms
Description	Clears the grade terms.
Compliance	`mandatory`		This method must be implemented.
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 a 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.
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	matchAnyGradeSystem
Description	Matches gradebooks that have any grade system.
Parameters	`boolean`	`match`	`true` to match gradebooks with any grade system, `false` to match gradebooks with no grade system
Compliance	`mandatory`		This method must be implemented.
Method	clearGradeSystemTerms
Description	Clears the grade system 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 a 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.
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 gradebooks that have any grade entry.
Parameters	`boolean`	`match`	`true` to match gradebooks with any grade entry, `false` to match gradebooks with no grade entry
Compliance	`mandatory`		This method must be implemented.
Method	clearGradeEntryTerms
Description	Clears the grade entry terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchGradebookColumnId
Description	Sets the gradebook column `Id` for this query.
Parameters	`osid.id.Id`	`gradebookColumnId`	a gradebook column `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`gradebookColumnId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearGradebookColumnIdTerms
Description	Clears the gradebook column `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsGradebookColumnQuery
Description	Tests if a `GradebookColumnQuery` is available.
Return	`boolean`		`true` if a gradebook column query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getGradebookColumnQuery
Description	Gets the query for a gradebook column. Multiple retrievals produce a nested `OR` term.
Return	`osid.grading.GradebookColumnQuery`		the gradebook column query
Errors	UNIMPLEMENTED		`supportsGradebookColumnQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsGradebookColumnQuery()` is `true`.
Method	matchAnyGradebookColumn
Description	Matches gradebooks that have any column.
Parameters	`boolean`	`match`	`true` to match gradebooks with any column, `false` to match gradebooks with no column
Compliance	`mandatory`		This method must be implemented.
Method	clearGradebookColumnTerms
Description	Clears the gradebook column terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAncestorGradebookId
Description	Sets the gradebook `Id` for this query to match gradebooks that have the specified gradebook as an ancestor.
Parameters	`osid.id.Id`	`gradebookId`	a gradebook `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`gradebookId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorGradebookIdTerms
Description	Clears the ancestor gradebook `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAncestorGradebookQuery
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	getAncestorGradebookQuery
Description	Gets the query for a gradebook. Multiple retrievals produce a nested `OR` term.
Return	`osid.grading.GradebookQuery`		the gradebook query
Errors	UNIMPLEMENTED		`supportsAncestorGradebookQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAncestorGradebookQuery()` is `true`.
Method	matchAnyAncestorGradebook
Description	Matches gradebook with any ancestor.
Parameters	`boolean`	`match`	`true` to match gradebooks with any ancestor, `false` to match root gradebooks
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorGradebookTerms
Description	Clears the ancestor gradebook terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDescendantGradebookId
Description	Sets the gradebook `Id` for this query to match gradebooks that have the specified gradebook as a descendant.
Parameters	`osid.id.Id`	`gradebookId`	a gradebook `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`gradebookId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantGradebookIdTerms
Description	Clears the descendant gradebook `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsDescendantGradebookQuery
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	getDescendantGradebookQuery
Description	Gets the query for a gradebook. Multiple retrievals produce a nested `OR` term.
Return	`osid.grading.GradebookQuery`		the gradebook query
Errors	UNIMPLEMENTED		`supportsDescendantGradebookQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDescendantGradebookQuery()` is `true`.
Method	matchAnyDescendantGradebook
Description	Matches gradebook with any descendant.
Parameters	`boolean`	`match`	`true` to match gradebooks with any descendant, `false` to match leaf gradebooks
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantGradebookTerms
Description	Clears the descendant gradebook terms.
Compliance	`mandatory`		This method must be implemented.
Method	getGradebookQueryRecord
Description	Gets the gradebook query record corresponding to the given `Gradebook` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`gradebookRecordType`	a gradebook record type
Return	`osid.grading.records.GradebookQueryRecord`		the gradebook query record
Errors	NULL_ARGUMENT		`gradebookRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(gradebookRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.