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.ModuleSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidGovernatorSearchOrder | ||
osid.OsidSubjugateableSearchOrder | |||
| Description |
An interface for specifying the ordering of search results. | ||
| Method | orderBySyllabus | ||
| Description |
Specifies a preference for ordering the result set by the syllabus. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsSyllabusSearchOrder | ||
| Description |
Tests if a syllabus order is available. | ||
| Return | boolean | true if a syllabus order is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getSyllabusSearchOrder | ||
| Description |
Gets the syllabus order. | ||
| Return | osid.course.syllabus.SyllabusSearchOrder | the syllabus search order | |
| Errors | UNIMPLEMENTED | supportsSyllabusSearchOrder() is false | |
| Compliance | optional | This method must be implemented if supportsCourseSearchOrder()
is true. | |
| Method | getModuleSearchOrderRecord | ||
| Description |
Gets the module search order record corresponding to
the given module record | ||
| Parameters | osid.type.Type | moduleRecordType | a module record type |
| Return | osid.course.syllabus.records.ModuleSearchOrderRecord | the module search order record | |
| Errors | NULL_ARGUMENT | moduleRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(moduleRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |