Interface | osid.grading.GradeEntrySearchOrder | ||
---|---|---|---|
Implements | osid.OsidRelationshipSearchOrder | ||
Description |
An interface for specifying the ordering of search results. | ||
Method | orderByGradebookColumn | ||
Description |
Specified a preference for ordering results by the gradebook column. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsGradebookColumnSearchOrder | ||
Description |
Tests if a | ||
Return | boolean | true if a gradebook column search order is available,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getGradebookColumnSearchOrder | ||
Description |
Gets the search order for a gradebook column. | ||
Return | osid.grading.GradebookColumnSearchOrder | the gradebook column search order | |
Errors | UNIMPLEMENTED | supportsGradebookColumnSearchOrder() is false | |
Compliance | optional | This method must be implemented if
supportsGradebookColumnSearchOrder() is true. | |
Method | orderByKeyResource | ||
Description |
Specified a preference for ordering results by the key resource. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsKeyResourceSearchOrder | ||
Description |
Tests if a | ||
Return | boolean | true if a key resource search order is available,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getKeyResourceSearchOrder | ||
Description |
Gets the search order for a resource. | ||
Return | osid.resource.ResourceSearchOrder | the key resource search order | |
Errors | UNIMPLEMENTED | supportsKeyResourceSearchOrder() is false | |
Compliance | optional | This method must be implemented if supportsKeyResourceSearchOrder()
is true. | |
Method | orderByDerived | ||
Description |
Specified a preference for ordering results by the derived entries. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderByIgnoredForCalculations | ||
Description |
Specified a preference for ordering results by the ignore for calculations flag. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderByGrade | ||
Description |
Specified a preference for ordering results by the grade or score. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsGradeSearchOrder | ||
Description |
Tests if a | ||
Return | boolean | true if a grade search order is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getGradeSearchOrder | ||
Description |
Gets the search order for a grade. | ||
Return | osid.grading.GradeSearchOrder | the grade search order | |
Errors | UNIMPLEMENTED | supportsGradeSearchOrder() is false | |
Compliance | optional | This method must be implemented if supportsGradeSearchOrder()
is true. | |
Method | orderByTimeGraded | ||
Description |
Specified a preference for ordering results by the time graded. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderByGrader | ||
Description |
Specified a preference for ordering results by the grader. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsGraderSearchOrder | ||
Description |
Tests if a | ||
Return | boolean | true if a resource search order is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getGraderSearchOrder | ||
Description |
Gets the search order for a grader. | ||
Return | osid.resource.ResourceSearchOrder | the resource search order | |
Errors | UNIMPLEMENTED | supportsGraderSearchOrder() is false | |
Compliance | optional | This method must be implemented if supportsGraderSearchOrder()
is true. | |
Method | orderByGradingAgent | ||
Description |
Specified a preference for ordering results by the grading agent. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsGradingAgentSearchOrder | ||
Description |
Tests if an | ||
Return | boolean | true if an agent search order is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getGradingAgentSearchOrder | ||
Description |
Gets the search order for a grading agent. | ||
Return | osid.authentication.AgentSearchOrder | the agent search order | |
Errors | UNIMPLEMENTED | supportsGradingAgentSearchOrder() is false | |
Compliance | optional | This method must be implemented if supportsGradingAgentSearchOrder()
is true. | |
Method | getGradeEntrySearchOrderRecord | ||
Description |
Gets the grade entry search order record corresponding
to the given grade entry record | ||
Parameters | osid.type.Type | gradeEntryRecordType | a grade entry record type |
Return | osid.grading.records.GradeEntrySearchOrderRecord | the grade entry search order record | |
Errors | NULL_ARGUMENT | gradeEntryRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(gradeEntryRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |