| Interface | osid.grading.GradeSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidObjectSearchOrder | ||
osid.OsidSubjugateableSearchOrder | |||
| 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 | getGradeSystemSearchOrder | ||
| 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 | orderByInputScoreStartRange | ||
| Description | 
                     Specified a preference for ordering results by start of the input score range.  | ||
| Parameters | osid.SearchOrderStyle | style | search order style | 
| Errors | NULL_ARGUMENT |  style  is  null   |                 |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByInputScoreEndRange | ||
| Description | 
                     Specified a preference for ordering results by end of the input score range.  | ||
| Parameters | osid.SearchOrderStyle | style | search order style | 
| Errors | NULL_ARGUMENT |  style  is  null   |                 |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByOutputScore | ||
| Description | 
                     Specified a preference for ordering results by the output score.  | ||
| Parameters | osid.SearchOrderStyle | style | search order style | 
| Errors | NULL_ARGUMENT |  style  is  null   |                 |
| Compliance | mandatory | This method must be implemented. | |
| Method | getGradeSearchOrderRecord | ||
| Description | 
                     Gets the grade search order record corresponding to the 
                    given grade record   | ||
| Parameters | osid.type.Type | gradeRecordType | a grade record type | 
| Return | osid.grading.records.GradeSearchOrderRecord | the grade search order record | |
| Errors | NULL_ARGUMENT |  gradeRecordType  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED |  hasRecordType(gradeRecordType)  is  false   |                 ||
| Compliance | mandatory | This method must be implemented. | |