OSID - osid.grading.GradeEntryQuery Service Interface Definition

Interface	osid.grading.GradeEntryQuery
Implements	`osid.OsidRelationshipQuery`
Used By	`osid.grading.GradeEntryQuery`
	`osid.grading.GradeEntryQuerySession`
	`osid.grading.GradeEntrySearchSession`
	`osid.grading.GradeEntrySmartGradebookSession`
	`osid.grading.GradeQuery`
	`osid.grading.GradebookColumnQuery`
	`osid.grading.GradebookQuery`
Description	This is the query for searching grade entries. Each method match request produces an `AND` term while multiple invocations of a method produces a nested `OR`.
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 for querying creators.
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	clearGradebookColumnTerms
Description	Clears the gradebook column terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchKeyResourceId
Description	Sets the key resource `Id` for this query.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`resourceId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearKeyResourceIdTerms
Description	Clears the key resource `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsKeyResourceQuery
Description	Tests if a `ResourceQUery` is available for querying key resources.
Return	`boolean`		`true` if a resource query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getKeyResourceQuery
Description	Gets the query for a key resource. Multiple retrievals produce a nested `OR` term.
Return	`osid.resource.ResourceQuery`		the resource query
Errors	UNIMPLEMENTED		`supportsKeyResourceQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsKeyResourceQuery()` is `true`.
Method	matchAnyKeyResource
Description	Matches grade entries with any key resource.
Parameters	`boolean`	`match`	`true` to match grade entries with any key resource, `false` to match entries with no key resource
Compliance	`mandatory`		This method must be implemented.
Method	clearKeyResourceTerms
Description	Clears the key resource terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDerived
Description	Matches derived grade entries.
Parameters	`boolean`	`match`	`true` to match derived grade entries, `false` to match manual entries
Compliance	`mandatory`		This method must be implemented.
Method	clearDerivedTerms
Description	Clears the derived terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchOverriddenGradeEntryId
Description	Sets the grade entry `Id` for an overridden calculated grade entry.
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	clearOverriddenGradeEntryIdTerms
Description	Clears the overridden grade entry `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsOverriddenGradeEntryQuery
Description	Tests if a `GradeEntry` is available for querying overridden calculated grade entries.
Return	`boolean`		`true` if a grade entry query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getOverriddenGradeEntryQuery
Description	Gets the query for an overridden derived grade entry. Multiple retrievals produce a nested `OR` term.
Return	`osid.grading.GradeEntryQuery`		the grade entry query
Errors	UNIMPLEMENTED		`supportsOverriddenGradeEntryQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsOverriddenGradeEntryQuery()` is `true`.
Method	matchAnyOverriddenGradeEntry
Description	Matches grade entries overriding any calculated grade entry.
Parameters	`boolean`	`match`	`true` to match grade entries overriding any grade entry, `false` to match entries not overriding any entry
Compliance	`mandatory`		This method must be implemented.
Method	clearOverriddenGradeEntryTerms
Description	Clears the overridden grade entry terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchIgnoredForCalculations
Description	Matches grade entries ignored for calculations.
Parameters	`boolean`	`match`	`true` to match grade entries ignored for calculations, `false` to match entries used in calculations
Compliance	`mandatory`		This method must be implemented.
Method	clearIgnoredForCalculationsTerms
Description	Clears the ignored for calculation entries terms.
Compliance	`mandatory`		This method must be implemented.
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 for querying grades.
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 grade entries with any grade.
Parameters	`boolean`	`match`	`true` to match grade entries with any grade, `false` to match entries 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	matchScore
Description	Matches grade entries which score is between the specified score inclusive.
Parameters	`decimal`	`start`	start of range
	`decimal`	`end`	end of range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`end` is less than `start`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyScore
Description	Matches grade entries with any score.
Parameters	`boolean`	`match`	`true` to match grade entries with any score, `false` to match entries with no score
Compliance	`mandatory`		This method must be implemented.
Method	clearScoreTerms
Description	Clears the score terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchTimeGraded
Description	Matches grade entries which graded time is between the specified times inclusive.
Parameters	`osid.calendaring.DateTime`	`start`	start of range
	`osid.calendaring.DateTime`	`end`	end of range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`end` is less than `start`
Compliance	`mandatory`		This method must be implemented.
Method	clearTimeGradedTerms
Description	Clears the time graded terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchGraderId
Description	Sets the agent `Id` for this query.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`resourceId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearGraderIdTerms
Description	Clears the grader `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsGraderQuery
Description	Tests if a `ResourceQuery` is available for querying graders.
Return	`boolean`		`true` if a resource query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getGraderQuery
Description	Gets the query for an agent. Multiple retrievals produce a nested `OR` term.
Return	`osid.resource.ResourceQuery`		the resource query
Errors	UNIMPLEMENTED		`supportsResourceQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsResourceQuery()` is `true`.
Method	matchAnyGrader
Description	Matches grade entries with any grader.
Parameters	`boolean`	`match`	`true` to match grade entries with any grader, `false` to match entries with no grader
Compliance	`mandatory`		This method must be implemented.
Method	clearGraderTerms
Description	Clears the grader terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchGradingAgentId
Description	Sets the grading agent `Id` for this query.
Parameters	`osid.id.Id`	`agentId`	an agent `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`agentId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearGradingAgentIdTerms
Description	Clears the grader `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsGradingAgentQuery
Description	Tests if an `AgentQuery` is available for querying grading agents.
Return	`boolean`		`true` if an agent query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getGradingAgentQuery
Description	Gets the query for an agent. Multiple retrievals produce a nested `OR` term.
Return	`osid.authentication.AgentQuery`		the agent query
Errors	UNIMPLEMENTED		`supportsGradingAgentQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsGradingAgentQuery()` is `true`.
Method	matchAnyGradingAgent
Description	Matches grade entries with any grading agent.
Parameters	`boolean`	`match`	`true` to match grade entries with any grading agent, `false` to match entries with no grading agent
Compliance	`mandatory`		This method must be implemented.
Method	clearGradingAgentTerms
Description	Clears the grading agent 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 resources.
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 `supportsGradebookQuery()` is `true`.
Method	clearGradebookTerms
Description	Clears the gradebook terms.
Compliance	`mandatory`		This method must be implemented.
Method	getGradeEntryQueryRecord
Description	Gets the grade entry query record corresponding to the given `GradeEntry` record `Type`. Multiple retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`gradeEntryRecordType`	a grade entry record type
Return	`osid.grading.records.GradeEntryQueryRecord`		the grade entry query record
Errors	NULL_ARGUMENT		`gradeEntryRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(gradeEntryRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.