OSID Specifications
course chronicle package
Version 3.1.0
course chronicle package
Version 3.1.0
| Interface | osid.course.chronicle.CourseEntrySearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidRelationshipSearchOrder | ||
| Used By | osid.course.chronicle.CourseEntrySearchSession | ||
osid.course.chronicle.CourseEntrySmartCourseCatalogSession | |||
| Description |
An interface for specifying the ordering of search results. | ||
| Method | orderByStudent | ||
| Description |
Specifies a preference for ordering the result set by the resource. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsStudentSearchOrder | ||
| Description |
Tests if a resource order is available. | ||
| Return | boolean | true if a resource order is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getStudentSearchOrder | ||
| Description |
Gets the resource order. | ||
| Return | osid.resource.ResourceSearchOrder | the resource search order | |
| Errors | UNIMPLEMENTED | supportsStudentSearchOrder() is false | |
| Compliance | optional | This method must be implemented if
supportsStudentSearchOrder() is true. | |
| Method | orderByCourse | ||
| Description |
Specifies a preference for ordering the result set by the course. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsCourseSearchOrder | ||
| Description |
Tests if a course order is available. | ||
| Return | boolean | true if a course order is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCourseSearchOrder | ||
| Description |
Gets the course order. | ||
| Return | osid.course.CourseSearchOrder | the course search order | |
| Errors | UNIMPLEMENTED | supportsCourseSearchOrder() is false | |
| Compliance | optional | This method must be implemented if
supportsCourseSearchOrder() is true. | |
| Method | orderByTerm | ||
| Description |
Specifies a preference for ordering the result set by the term. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsTermSearchOrder | ||
| Description |
Tests if a term order is available. | ||
| Return | boolean | true if a term order is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getTermSearchOrder | ||
| Description |
Gets the term order. | ||
| Return | osid.course.TermSearchOrder | the term search order | |
| Errors | UNIMPLEMENTED | supportsTermSearchOrder() is false | |
| Compliance | optional | This method must be implemented if supportsTermSearchOrder()
is true. | |
| Method | orderByIsRegistrationKnown | ||
| Description |
Specifies a preference for ordering results by the is registration known flag. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByCourseBeginDate | ||
| Description |
Specifies a preference for ordering results by course begin date. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByCourseEndDate | ||
| Description |
Specifies a preference for ordering results by course end date. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByComplete | ||
| Description |
Specifies a preference for ordering the result set by completed courses. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByCreditScale | ||
| Description |
Specifies a preference for ordering the result set by the grade system for credits. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsCreditScaleSearchOrder | ||
| Description |
Tests if a grade system order is available. | ||
| Return | boolean | true if a grade system order is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCreditScaleSearchOrder | ||
| Description |
Gets the grade system search order. | ||
| Return | osid.grading.GradeSystemSearchOrder | the credit scale search order | |
| Errors | UNIMPLEMENTED | supportsCreditScaleSearchOrder() is false | |
| Compliance | optional | This method must be implemented if
supportsCreditScaleSearchOrder() is true. | |
| Method | orderByCreditsEarned | ||
| Description |
Specifies a preference for ordering the result set by the earned credits. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByGrade | ||
| Description |
Specifies a preference for ordering the result set by the grade. | ||
| 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 grade search order is available. | ||
| Return | boolean | true if a grade order is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getGradeSearchOrder | ||
| Description |
Gets the grade system search order. | ||
| 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 | orderByScoreScale | ||
| 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 | supportsScoreScaleSearchOrder | ||
| Description |
Tests if a grade system order is available. | ||
| Return | boolean | true if a grade system order is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getScoreScaleSearchOrder | ||
| Description |
Gets the grade system order. | ||
| Return | osid.grading.GradeSystemSearchOrder | the grade system search order | |
| Errors | UNIMPLEMENTED | supportsScoreScaleSearchOrder() is false | |
| Compliance | optional | This method must be implemented if
supportsScoreScaleSearchOrder() is true. | |
| Method | orderByScore | ||
| Description |
Specifies a preference for ordering the result set by the score. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCourseEntrySearchOrderRecord | ||
| Description |
Gets the course entry search order record
corresponding to the given course entry entry record
| ||
| Parameters | osid.type.Type | courseEntryRecordType | a course entry record type |
| Return | osid.course.chronicle.records.CourseEntrySearchOrderRecord | the course entry search order record | |
| Errors | NULL_ARGUMENT | courseEntryRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(courseEntryRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |