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

MethodmatchGradeSystemId
Description

Sets the grade system Id for this query.

Parametersosid.id.IdgradeSystemIda grade system Id
booleanmatch true for a positive match, false for a 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.

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.
MethodmatchAnyGradeSystem
Description

Matches gradebooks that have any grade system.

Parametersbooleanmatch true to match gradebooks with any grade system, false to match gradebooks with no grade system
CompliancemandatoryThis method must be implemented.
MethodclearGradeSystemTerms
Description

Clears the grade system 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 a 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.

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 gradebooks that have any grade entry.

Parametersbooleanmatch true to match gradebooks with any grade entry, false to match gradebooks with no grade entry
CompliancemandatoryThis method must be implemented.
MethodclearGradeEntryTerms
Description

Clears the grade entry terms.

CompliancemandatoryThis method must be implemented.
MethodmatchGradebookColumnId
Description

Sets the gradebook column Id for this query.

Parametersosid.id.IdgradebookColumnIda gradebook column Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT gradebookColumnId is null
CompliancemandatoryThis method must be implemented.
MethodclearGradebookColumnIdTerms
Description

Clears the gradebook column Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsGradebookColumnQuery
Description

Tests if a GradebookColumnQuery is available.

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

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

Returnosid.grading.GradebookColumnQuerythe gradebook column query
ErrorsUNIMPLEMENTED supportsGradebookColumnQuery() is false
ComplianceoptionalThis method must be implemented if supportsGradebookColumnQuery() is true.
MethodmatchAnyGradebookColumn
Description

Matches gradebooks that have any column.

Parametersbooleanmatch true to match gradebooks with any column, false to match gradebooks with no column
CompliancemandatoryThis method must be implemented.
MethodclearGradebookColumnTerms
Description

Clears the gradebook column terms.

CompliancemandatoryThis method must be implemented.
MethodmatchAncestorGradebookId
Description

Sets the gradebook Id for this query to match gradebooks that have the specified gradebook as an ancestor.

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

Clears the ancestor gradebook Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsAncestorGradebookQuery
Description

Tests if a GradebookQuery is available.

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

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

Returnosid.grading.GradebookQuerythe gradebook query
ErrorsUNIMPLEMENTED supportsAncestorGradebookQuery() is false
ComplianceoptionalThis method must be implemented if supportsAncestorGradebookQuery() is true.
MethodmatchAnyAncestorGradebook
Description

Matches gradebook with any ancestor.

Parametersbooleanmatch true to match gradebooks with any ancestor, false to match root gradebooks
CompliancemandatoryThis method must be implemented.
MethodclearAncestorGradebookTerms
Description

Clears the ancestor gradebook terms.

CompliancemandatoryThis method must be implemented.
MethodmatchDescendantGradebookId
Description

Sets the gradebook Id for this query to match gradebooks that have the specified gradebook as a descendant.

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

Clears the descendant gradebook Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsDescendantGradebookQuery
Description

Tests if a GradebookQuery is available.

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

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

Returnosid.grading.GradebookQuerythe gradebook query
ErrorsUNIMPLEMENTED supportsDescendantGradebookQuery() is false
ComplianceoptionalThis method must be implemented if supportsDescendantGradebookQuery() is true.
MethodmatchAnyDescendantGradebook
Description

Matches gradebook with any descendant.

Parametersbooleanmatch true to match gradebooks with any descendant, false to match leaf gradebooks
CompliancemandatoryThis method must be implemented.
MethodclearDescendantGradebookTerms
Description

Clears the descendant gradebook terms.

CompliancemandatoryThis method must be implemented.
MethodgetGradebookQueryRecord
Description

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

Parametersosid.type.TypegradebookRecordTypea gradebook record type
Returnosid.grading.records.GradebookQueryRecordthe gradebook query record
ErrorsNULL_ARGUMENT gradebookRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(gradebookRecordType) is false
CompliancemandatoryThis method must be implemented.