OSID Logo
OSID Specifications
grading package
Version 3.0.0
Release Candidate Preview
Interfaceosid.grading.GradeQuery
Implementsosid.OsidObjectQuery
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.

MethodmatchGradeSystemId
Description

Sets the grade system Id for this query.

Parametersosid.id.IdgradeSystemIda grade system Id
booleanmatch true for a positive match, false for negative match
ErrorsNULL_ARGUMENT gradeSystemId is null
CompliancemandatoryThis method must be implemented.
MethodclearGradeSystemIdTerms
Description

Clears the grade system Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsGradeSystemQuery
Description

Tests if a GradeSystemQuery is available for querying grade systems.

Returnboolean true if a grade system query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetGradeSystemQuery
Description

Gets the query for a grade system. Multiple retrievals produce a nested OR term.

Returnosid.grading.GradeSystemQuerythe grade system query
ErrorsUNIMPLEMENTED supportsGradeSystemQuery() is false
ComplianceoptionalThis method must be implemented if supportsGradeSystemQuery() is true.
MethodclearGradeSystemTerms
Description

Clears the grade system terms.

CompliancemandatoryThis method must be implemented.
MethodmatchInputScoreStartRange
Description

Matches grades with the start input score inclusive.

Parametersdecimalstartstart of range
decimalendend of range
booleanmatch true for a positive match, false for negative match
ErrorsINVALID_ARGUMENT start is greater than end
CompliancemandatoryThis method must be implemented.
MethodclearInputScoreStartRangeTerms
Description

Clears the nput score start range terms.

CompliancemandatoryThis method must be implemented.
MethodmatchInputScoreEndRange
Description

Matches grades with the end input score inclusive.

Parametersdecimalstartstart of range
decimalendend of range
booleanmatch true for a positive match, false for negative match
ErrorsINVALID_ARGUMENT start is greater than end
CompliancemandatoryThis method must be implemented.
MethodclearInputScoreEndRangeTerms
Description

Clears the nput score start range terms.

CompliancemandatoryThis method must be implemented.
MethodmatchInputScore
Description

Matches grades with the input score range contained within the given range inclusive.

Parametersdecimalstartstart of range
decimalendend of range
booleanmatch true for a positive match, false for negative match
ErrorsINVALID_ARGUMENT start is greater than end
CompliancemandatoryThis method must be implemented.
MethodclearInputScoreTerms
Description

Clears the input score start range terms.

CompliancemandatoryThis method must be implemented.
MethodmatchOutputScore
Description

Matches grades with the output score contained within the given range inclusive.

Parametersdecimalstartstart of range
decimalendend of range
booleanmatch true for a positive match, false for negative match
ErrorsINVALID_ARGUMENT start is greater than end
CompliancemandatoryThis method must be implemented.
MethodclearOutputScoreTerms
Description

Clears the output score terms.

CompliancemandatoryThis method must be implemented.
MethodmatchGradeEntryId
Description

Sets the grade entry Id for this query.

Parametersosid.id.IdgradeEntryIda grade entry Id
booleanmatch true for a positive match, false for negative match
ErrorsNULL_ARGUMENT gradeEntryId is null
CompliancemandatoryThis method must be implemented.
MethodclearGradeEntryIdTerms
Description

Clears the grade entry Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsGradeEntryQuery
Description

Tests if a GradeEntryQuery is available for querying grade entries.

Returnboolean true if a grade entry query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetGradeEntryQuery
Description

Gets the query for a grade entry. Multiple retrievals produce a nested OR term.

Returnosid.grading.GradeEntryQuerythe grade entry query
ErrorsUNIMPLEMENTED supportsGradeEntryQuery() is false
ComplianceoptionalThis method must be implemented if supportsGradeEntryQuery() is true.
MethodmatchAnyGradeEntry
Description

Matches grades that are assigned to any grade entry.

Parametersbooleanmatch true to match grades used in any grade entry, false to match grades that are not used in any grade entries
CompliancemandatoryThis method must be implemented.
MethodclearGradeEntryTerms
Description

Clears the grade entry terms.

CompliancemandatoryThis method must be implemented.
MethodmatchGradebookId
Description

Sets the gradebook Id for this query.

Parametersosid.id.IdgradebookIda gradebook Id
booleanmatch true for a positive match, false for negative match
ErrorsNULL_ARGUMENT gradebookId is null
CompliancemandatoryThis method must be implemented.
MethodclearGradebookIdTerms
Description

Clears the gradebook Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsGradebookQuery
Description

Tests if a GradebookQuery is available .

Returnboolean true if a gradebook query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetGradebookQuery
Description

Gets the query for a gradebook. Multiple retrievals produce a nested OR term.

Returnosid.grading.GradebookQuerythe gradebook query
ErrorsUNIMPLEMENTED supportsGradebookQuery() is false
ComplianceoptionalThis method must be implemented if supportsGradebookColumnQuery() is true.
MethodclearGradebookTerms
Description

Clears the gradebook terms.

CompliancemandatoryThis method must be implemented.
MethodgetGradeQueryRecord
Description

Gets the grade query record corresponding to the given Grade record Type. Multiple retrievals produce a nested OR term.

Parametersosid.type.TypegradeRecordTypea grade record type
Returnosid.grading.records.GradeQueryRecordthe grade query record
ErrorsNULL_ARGUMENT gradeRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(gradeRecordType) is false
CompliancemandatoryThis method must be implemented.