OSID - osid.grading.GradeSystemQuery Service Interface Definition

Interface	osid.grading.GradeSystemQuery
Implements	`osid.OsidObjectQuery`
Implements	`osid.OsidAggregateableQuery`
Used By	`osid.assessment.AssessmentOfferedQuery`
	`osid.assessment.AssessmentTakenQuery`
	`osid.course.CourseOfferingQuery`
	`osid.course.CourseQuery`
	`osid.course.chronicle.AssessmentEntryQuery`
	`osid.course.chronicle.CourseEntryQuery`
	`osid.course.chronicle.ProgramEntryQuery`
	`osid.course.registration.RegistrationQuery`
	`osid.course.registration.RegistrationTargetQuery`
	`osid.course.registration.request.RegistrationRequestItemQuery`
	show 9 more…
`osid.grading.GradeQuery`
`osid.grading.GradeSystemQuerySession`
`osid.grading.GradeSystemSearchSession`
`osid.grading.GradeSystemSmartGradebookSession`
`osid.grading.GradebookColumnQuery`
`osid.grading.GradebookQuery`
`osid.offering.CanonicalUnitQuery`
`osid.offering.OfferingQuery`
`osid.offering.ParticipantQuery`
Description	This is the query for searching grade systems. Each method match request produces an `AND` term while multiple invocations of a method produces a nested `OR`.
Method	matchBasedOnGrades
Description	Matches grade systems based on grades.
Parameters	`boolean`	`match`	`true` for a positive match, `false` for negative match
Compliance	`mandatory`		This method must be implemented.
Method	clearBasedOnGradesTerms
Description	Clears the grade `based` 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 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 systems with any grade.
Parameters	`boolean`	`match`	`true` to match grade systems with any grade, `false` to match systems 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	matchLowestNumericScore
Description	Matches grade systems whose low end score falls in the specified range inclusive.
Parameters	`decimal`	`start`	low end of range
	`decimal`	`end`	high end of range
	`boolean`	`match`	`true` for a positive match, `false` for negative match
Errors	INVALID_ARGUMENT		`end` is less than `start`
Errors	NULL_ARGUMENT		`gradeId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearLowestNumericScoreTerms
Description	Clears the lowest numeric score terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchNumericScoreIncrement
Description	Matches grade systems numeric score increment is between the specified range inclusive.
Parameters	`decimal`	`start`	low end of range
	`decimal`	`end`	high end of range
	`boolean`	`match`	`true` for a positive match, `false` for negative match
Errors	INVALID_ARGUMENT		`end` is less than `start`
Errors	NULL_ARGUMENT		`gradeId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearNumericScoreIncrementTerms
Description	Clears the numeric score increment terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchHighestNumericScore
Description	Matches grade systems whose high end score falls in the specified range inclusive.
Parameters	`decimal`	`start`	low end of range
	`decimal`	`end`	high end of range
	`boolean`	`match`	`true` for a positive match, `false` for negative match
Errors	INVALID_ARGUMENT		`end` is less than `start`
Errors	NULL_ARGUMENT		`gradeId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearHighestNumericScoreTerms
Description	Clears the highest numeric score 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 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 grade systems assigned to any gradebook column.
Parameters	`boolean`	`match`	`true` to match grade systems mapped to any column, `false` to match systems mapped to no columns
Compliance	`mandatory`		This method must be implemented.
Method	clearGradebookColumnTerms
Description	Clears the gradebook column 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 `supportsGradebookQuery()` is `true`.
Method	clearGradebookTerms
Description	Clears the gradebook terms.
Compliance	`mandatory`		This method must be implemented.
Method	getGradeSystemQueryRecord
Description	Gets the grade system query record corresponding to the given `GradeSystem` record `Type`. Multiple retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`gradeSystemRecordType`	a grade system record type
Return	`osid.grading.records.GradeSystemQueryRecord`		the grade system query record
Errors	NULL_ARGUMENT		`gradeSystemRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(gradeSystemRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.