OSID - osid.grading.GradebookColumnQuery Service Interface Definition

Interface	osid.grading.GradebookColumnQuery
Implements	`osid.OsidObjectQuery`
Used By	`osid.grading.GradeEntryQuery`
	`osid.grading.GradeSystemQuery`
	`osid.grading.GradebookColumnQuerySession`
	`osid.grading.GradebookColumnSearchSession`
	`osid.grading.GradebookColumnSmartGradebookSession`
	`osid.grading.GradebookColumnSummaryQuery`
	`osid.grading.GradebookQuery`
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 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 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	matchAnyGradeSystem
Description	Matches gradebook columns with any grade system assigned.
Parameters	`boolean`	`match`	`true` to match columns with any grade system, `false` to match columns 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 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 gradebook columns with any grade entry assigned.
Parameters	`boolean`	`match`	`true` to match columns with any grade entry, `false` to match columns with no 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	supportsGradebookColumnSummaryQuery
Description	Tests if a `GradebookColumnSummaryQuery` is available for querying grade systems.
Return	`boolean`		`true` if a gradebook column summary query interface is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getGradebookColumnSummaryQuery
Description	Gets the query interface for a gradebook column summary. Multiple retrievals produce a nested `OR` term.
Return	`osid.grading.GradebookColumnSummaryQuery`		the gradebook column summary query
Errors	UNIMPLEMENTED		`supportsGradebookColumnSummaryQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsGradebookColumnSummaryQuery()` is `true`.
Method	clearGradebookColumnSummaryTerms
Description	Clears the gradebook column summary 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 a 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 for querying grade systems.
Return	`boolean`		`true` if a gradebook query interface is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getGradebookQuery
Description	Gets the query interface 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 `supportsGradebookQuery()` is `true`.
Method	clearGradebookTerms
Description	Clears the gradebook terms.
Compliance	`mandatory`		This method must be implemented.
Method	getGradebookColumnQueryRecord
Description	Gets the gradebook column query record corresponding to the given `GradebookColumn` record `Type`. Multiple retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`gradebookColumnRecordType`	a gradebook column record type
Return	`osid.grading.records.GradebookColumnQueryRecord`		the gradebook column query record
Errors	NULL_ARGUMENT		`gradebookColumnRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(gradebookColumnRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.