| Interface | osid.assessment.AssessmentOfferedSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidObjectSearchOrder | ||
osid.OsidSubjugateableSearchOrder | |||
| Description |
An interface for specifying the ordering of search results. | ||
| Method | orderByAssessment | ||
| Description |
Specifies a preference for ordering the result set by the assessment. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsAssessmentSearchOrder | ||
| Description |
Tests if an assessment search order is available. | ||
| Return | boolean | true if an assessment search order is available,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssessmentSearchOrder | ||
| Description |
Gets an assessment search order. | ||
| Return | osid.assessment.AssessmentSearchOrder | an assessment search order | |
| Errors | UNIMPLEMENTED | supportsAssessmentSearchOrder() is false | |
| Compliance | optional | This method must be implemented if supportsAssessmentSearchOrder()
is true. | |
| Method | orderByLevel | ||
| Description |
Specifies a preference for ordering the result set by the level of difficulty. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsLevelSearchOrder | ||
| Description |
Tests if a grade search order is available. | ||
| Return | boolean | true if a grade search order is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getLevelSearchOrder | ||
| Description |
Gets a grade search order. | ||
| Return | osid.grading.GradeSearchOrder | a grade search order | |
| Errors | UNIMPLEMENTED | supportsLevelSearchOrder() is false | |
| Compliance | optional | This method must be implemented if supportsLevelSearchOrder()
is true. | |
| Method | orderByItemsSequential | ||
| Description |
Specifies a preference for ordering the result set by the sequential flag. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByItemsShuffled | ||
| Description |
Specifies a preference for ordering the result set by the shuffle flag. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByStartTime | ||
| Description |
Specifies a preference for ordering the result set by the assessment start time. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByDeadline | ||
| Description |
Specifies a preference for ordering the result set by the assessment deadline. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByDuration | ||
| Description |
Specifies a preference for ordering the result set by the duration. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByScoreSystem | ||
| Description |
Specifies a preference for ordering the result set by the grade system for scores. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsScoreSystemSearchOrder | ||
| Description |
Tests if a grade system search order is available. | ||
| Return | boolean | true if a grade system search order is available,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getScoreSystemSearchOrder | ||
| Description |
Gets a grade system search order. | ||
| Return | osid.grading.GradeSystemSearchOrder | a grade system search order | |
| Errors | UNIMPLEMENTED | supportsScoreSystemSearchOrder() is false | |
| Compliance | optional | This method must be implemented if supportsScoreSystemSearchOrder()
is true. | |
| Method | orderByGradeSystem | ||
| Description |
Specifies a preference for ordering the result set by the grade system for grades. | ||
| 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 grade system search order is available. | ||
| Return | boolean | true if a grade system search order is available,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getGradeSystemSearchOrder | ||
| Description |
Gets a grade system search order. | ||
| Return | osid.grading.GradeSystemSearchOrder | a grade system search order | |
| Errors | UNIMPLEMENTED | supportsGradeSystemSearchOrder() is false | |
| Compliance | optional | This method must be implemented if supportsGradeSystemSearchOrder()
is true. | |
| Method | orderByRubric | ||
| Description |
Specifies a preference for ordering the result set by the rubric assessment offered. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsRubricSearchOrder | ||
| Description |
Tests if an assessment offered search order is available. | ||
| Return | boolean | true if an assessment offered search order is available,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRubricSearchOrder | ||
| Description |
Gets an assessment offered search order. | ||
| Return | osid.assessment.AssessmentOfferedSearchOrder | a rubric assessment offered search order | |
| Errors | UNIMPLEMENTED | supportsRubricSearchOrder() is false | |
| Compliance | optional | This method must be implemented if supportsRubricSearchOrder()
is true. | |
| Method | getAssessmentOfferedSearchOrderRecord | ||
| Description |
Gets the assessment offered search order record
corresponding to the given assessment record | ||
| Parameters | osid.type.Type | assessmentOfferedRecordType | an assessment offered record type |
| Return | osid.assessment.records.AssessmentOfferedSearchOrderRecord | the assessment offered search order record | |
| Errors | NULL_ARGUMENT | assessmentOfferedRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(assessmentOfferedRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |