OSID Specifications
course syllabus package
Version 3.0.0
Release Candidate Preview
course syllabus package
Version 3.0.0
Release Candidate Preview
| Interface | osid.course.syllabus.SyllabusSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidObjectSearchOrder | ||
osid.OsidSubjugateableSearchOrder | |||
| Description |
An interface for specifying the ordering of search results. | ||
| 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 | getSyllabusSearchOrderRecord | ||
| Description |
Gets the syllabus search order record corresponding to
the given syllabus record | ||
| Parameters | osid.type.Type | syllabusRecordType | a syllabus record type |
| Return | osid.course.syllabus.records.SyllabusSearchOrderRecord | the syllabus search order record | |
| Errors | NULL_ARGUMENT | syllabusRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(syllabusRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |