OSID Logo
OSID Specifications
grading package
Version 3.0.0
Release Candidate Preview
Interfaceosid.grading.GradebookColumnSummaryQuery
Implementsosid.OsidRuleQuery
Description

This is the query for searching gradebook column summaries. Each method match request produces an AND term while multiple invocations of a method produces a nested OR.

MethodmatchGradebookColumnId
Description

Sets the gradebook column Id for this query.

Parametersosid.id.IdgradebookColumnIda gradeboo 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 for querying gradebook column.

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 gradebook column derivations with any gradebookc olumn.

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

Clears the source grade system terms.

CompliancemandatoryThis method must be implemented.
MethodmatchMean
Description

Matches a mean between the given values inclusive.

Parametersdecimallowlow end of range
decimalhighhigh end of range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT low is greater than high
CompliancemandatoryThis method must be implemented.
MethodclearMeanTerms
Description

Clears the mean terms.

CompliancemandatoryThis method must be implemented.
MethodmatchMinimumMean
Description

Matches a mean greater than or equal to the given value.

Parametersdecimalvalueminimum value
booleanmatch true for a positive match, false for a negative match
CompliancemandatoryThis method must be implemented.
MethodclearMinimumMeanTerms
Description

Clears the minimum mean terms.

CompliancemandatoryThis method must be implemented.
MethodmatchMedian
Description

Matches a median between the given values inclusive.

Parametersdecimallowlow end of range
decimalhighhigh end of range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT low is greater than high
CompliancemandatoryThis method must be implemented.
MethodclearMedianTerms
Description

Clears the median terms.

CompliancemandatoryThis method must be implemented.
MethodmatchMinimumMedian
Description

Matches a median greater than or equal to the given value.

Parametersdecimalvalueminimum value
booleanmatch true for a positive match, false for a negative match
CompliancemandatoryThis method must be implemented.
MethodclearMinimumMedianTerms
Description

Clears the minimum median terms.

CompliancemandatoryThis method must be implemented.
MethodmatchMode
Description

Matches a mode between the given values inclusive.

Parametersdecimallowlow end of range
decimalhighhigh end of range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT low is greater than high
CompliancemandatoryThis method must be implemented.
MethodclearModeTerms
Description

Clears the mode terms.

CompliancemandatoryThis method must be implemented.
MethodmatchMinimumMode
Description

Matches a mode greater than or equal to the given value.

Parametersdecimalvalueminimum value
booleanmatch true for a positive match, false for a negative match
CompliancemandatoryThis method must be implemented.
MethodclearMinimumModeTerms
Description

Clears the minimum mode terms.

CompliancemandatoryThis method must be implemented.
MethodmatchRMS
Description

Matches a root mean square between the given values inclusive.

Parametersdecimallowlow end of range
decimalhighhigh end of range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT low is greater than high
CompliancemandatoryThis method must be implemented.
MethodclearRMSTerms
Description

Clears the root mean square terms.

CompliancemandatoryThis method must be implemented.
MethodmatchMinimumRMS
Description

Matches a root mean square greater than or equal to the given value.

Parametersdecimalvalueminimum value
booleanmatch true for a positive match, false for a negative match
CompliancemandatoryThis method must be implemented.
MethodclearMinimumRMSTerms
Description

Clears the minimum RMS terms.

CompliancemandatoryThis method must be implemented.
MethodmatchStandardDeviation
Description

Matches a standard deviation mean square between the given values inclusive.

Parametersdecimallowlow end of range
decimalhighhigh end of range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT low is greater than high
CompliancemandatoryThis method must be implemented.
MethodclearStandardDeviationTerms
Description

Clears the standard deviation terms.

CompliancemandatoryThis method must be implemented.
MethodmatchMinimumStandardDeviation
Description

Matches a standard deviation greater than or equal to the given value.

Parametersdecimalvalueminimum value
booleanmatch true for a positive match, false for a negative match
CompliancemandatoryThis method must be implemented.
MethodclearMinimumStandardDeviationTerms
Description

Clears the minimum standard deviation terms.

CompliancemandatoryThis method must be implemented.
MethodmatchSum
Description

Matches a sum mean square between the given values inclusive.

Parametersdecimallowlow end of range
decimalhighhigh end of range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENT low is greater than high
CompliancemandatoryThis method must be implemented.
MethodclearSumTerms
Description

Clears the sum terms.

CompliancemandatoryThis method must be implemented.
MethodmatchMinimumSum
Description

Matches a sum greater than or equal to the given value.

Parametersdecimalvalueminimum value
booleanmatch true for a positive match, false for a negative match
CompliancemandatoryThis method must be implemented.
MethodclearMinimumSumTerms
Description

Clears the minimum sum 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 a 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.
MethodgetGradebookColumnSummaryQueryRecord
Description

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

Parametersosid.type.TypegradebookColumnSummaryRecordTypea gradebook column summary record type
Returnosid.grading.records.GradebookColumnSummaryQueryRecordthe gradebook column summary query record
ErrorsNULL_ARGUMENT gradebookColumnSummaryRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(gradebookColumnSummaryRecordType) is false
CompliancemandatoryThis method must be implemented.