Interface | osid.grading.GradebookColumnSearchOrder | ||
---|---|---|---|
Implements | osid.OsidObjectSearchOrder | ||
Description |
An interface for specifying the ordering of search results. | ||
Method | orderByGradeSystem | ||
Description |
Specified a preference for ordering results by the grade system. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsGradeSystemSearchOrder | ||
Description |
Tests if a | ||
Return | boolean | true if a grade system search order is available,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getGradebookColumnSummarySearchOrder | ||
Description |
Gets the search order for a grade system. | ||
Return | osid.grading.GradeSystemSearchOrder | the grade system search order | |
Errors | UNIMPLEMENTED | supportsGradeSystemSearchOrder() is false | |
Compliance | optional | This method must be implemented if supportsGradeSystemSearchOrder()
is true. | |
Method | supportsGradebookColumnSummarySearchOrder | ||
Description |
Tests if a | ||
Return | boolean | true if a gradebook column summary search order is
available, false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getGradeSystemSearchOrder | ||
Description |
Gets the search order for a gradebook column summary search order. | ||
Return | osid.grading.GradebookColumnSummarySearchOrder | the gradebook column summary search order | |
Errors | UNIMPLEMENTED | supportsGradebookColumnSummarySearchOrder() is false
| |
Compliance | optional | This method must be implemented if
supportsGradebookColumnSummarySearchOrder() is true. | |
Method | getGradebookColumnSearchOrderRecord | ||
Description |
Gets the gradebook column search order record
corresponding to the given gradebook column record | ||
Parameters | osid.type.Type | gradebookColumnRecordType | a gradebook column record type |
Return | osid.grading.records.GradebookColumnSearchOrderRecord | the gradebook column search order record | |
Errors | NULL_ARGUMENT | gradebookColumnRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(gradebookColumnRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |