Interface | osid.grading.GradebookColumnSummaryQuery | ||
---|---|---|---|
Implements | osid.OsidRuleQuery | ||
Description |
This is the query for searching gradebook column summaries.
Each method match request produces an | ||
Method | matchGradebookColumnId | ||
Description |
Sets the gradebook column | ||
Parameters | osid.id.Id | gradebookColumnId | a gradeboo column Id |
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 | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsGradebookColumnQuery | ||
Description |
Tests if a | ||
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 | ||
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 gradebook column derivations with any gradebookc olumn. | ||
Parameters | boolean | match | true to match gradebook column derivations with any
gradebook column, false to match gradebook column derivations
with no gradebook columns |
Compliance | mandatory | This method must be implemented. | |
Method | clearGradebookColumnTerms | ||
Description |
Clears the source grade system terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchMean | ||
Description |
Matches a mean between the given values inclusive. | ||
Parameters | decimal | low | low end of range |
decimal | high | high end of range | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | low is greater than high | |
Compliance | mandatory | This method must be implemented. | |
Method | clearMeanTerms | ||
Description |
Clears the mean terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchMinimumMean | ||
Description |
Matches a mean greater than or equal to the given value. | ||
Parameters | decimal | value | minimum value |
boolean | match | true for a positive match, false for a
negative match | |
Compliance | mandatory | This method must be implemented. | |
Method | clearMinimumMeanTerms | ||
Description |
Clears the minimum mean terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchMedian | ||
Description |
Matches a median between the given values inclusive. | ||
Parameters | decimal | low | low end of range |
decimal | high | high end of range | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | low is greater than high | |
Compliance | mandatory | This method must be implemented. | |
Method | clearMedianTerms | ||
Description |
Clears the median terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchMinimumMedian | ||
Description |
Matches a median greater than or equal to the given value. | ||
Parameters | decimal | value | minimum value |
boolean | match | true for a positive match, false for a
negative match | |
Compliance | mandatory | This method must be implemented. | |
Method | clearMinimumMedianTerms | ||
Description |
Clears the minimum median terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchMode | ||
Description |
Matches a mode between the given values inclusive. | ||
Parameters | decimal | low | low end of range |
decimal | high | high end of range | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | low is greater than high | |
Compliance | mandatory | This method must be implemented. | |
Method | clearModeTerms | ||
Description |
Clears the mode terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchMinimumMode | ||
Description |
Matches a mode greater than or equal to the given value. | ||
Parameters | decimal | value | minimum value |
boolean | match | true for a positive match, false for a
negative match | |
Compliance | mandatory | This method must be implemented. | |
Method | clearMinimumModeTerms | ||
Description |
Clears the minimum mode terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchRMS | ||
Description |
Matches a root mean square between the given values inclusive. | ||
Parameters | decimal | low | low end of range |
decimal | high | high end of range | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | low is greater than high | |
Compliance | mandatory | This method must be implemented. | |
Method | clearRMSTerms | ||
Description |
Clears the root mean square terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchMinimumRMS | ||
Description |
Matches a root mean square greater than or equal to the given value. | ||
Parameters | decimal | value | minimum value |
boolean | match | true for a positive match, false for a
negative match | |
Compliance | mandatory | This method must be implemented. | |
Method | clearMinimumRMSTerms | ||
Description |
Clears the minimum RMS terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchStandardDeviation | ||
Description |
Matches a standard deviation mean square between the given values inclusive. | ||
Parameters | decimal | low | low end of range |
decimal | high | high end of range | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | low is greater than high | |
Compliance | mandatory | This method must be implemented. | |
Method | clearStandardDeviationTerms | ||
Description |
Clears the standard deviation terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchMinimumStandardDeviation | ||
Description |
Matches a standard deviation greater than or equal to the given value. | ||
Parameters | decimal | value | minimum value |
boolean | match | true for a positive match, false for a
negative match | |
Compliance | mandatory | This method must be implemented. | |
Method | clearMinimumStandardDeviationTerms | ||
Description |
Clears the minimum standard deviation terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchSum | ||
Description |
Matches a sum mean square between the given values inclusive. | ||
Parameters | decimal | low | low end of range |
decimal | high | high end of range | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | low is greater than high | |
Compliance | mandatory | This method must be implemented. | |
Method | clearSumTerms | ||
Description |
Clears the sum terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchMinimumSum | ||
Description |
Matches a sum greater than or equal to the given value. | ||
Parameters | decimal | value | minimum value |
boolean | match | true for a positive match, false for a
negative match | |
Compliance | mandatory | This method must be implemented. | |
Method | clearMinimumSumTerms | ||
Description |
Clears the minimum sum terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchGradebookId | ||
Description |
Sets the gradebook | ||
Parameters | osid.id.Id | gradebookId | a gradebook Id |
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 | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsGradebookQuery | ||
Description |
Tests if a | ||
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 | ||
Return | osid.grading.GradebookQuery | the gradebook query | |
Errors | UNIMPLEMENTED | supportsGradebookQuery() is false | |
Compliance | optional | This method must be implemented if supportsGradebookColumnQuery()
is true. | |
Method | clearGradebookTerms | ||
Description |
Clears the gradebook terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | getGradebookColumnSummaryQueryRecord | ||
Description |
Gets the gradebook column summary query record
corresponding to the given | ||
Parameters | osid.type.Type | gradebookColumnSummaryRecordType | a gradebook column summary record type |
Return | osid.grading.records.GradebookColumnSummaryQueryRecord | the gradebook column summary query record | |
Errors | NULL_ARGUMENT | gradebookColumnSummaryRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(gradebookColumnSummaryRecordType) is
false | ||
Compliance | mandatory | This method must be implemented. |