| Interface | osid.course.plan.LessonSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
The search interface for governing lesson searches. | ||
| Method | searchAmongLessons | ||
| Description |
Execute this search among the given list of lessons. | ||
| Parameters | osid.id.IdList | lessonIds | list of lessons |
| Errors | NULL_ARGUMENT | lessonIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderLessonResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.course.plan.LessonSearchOrder | lessonSearchOrder | lesson search order |
| Errors | NULL_ARGUMENT | lessonSearchOrder is null | |
| UNSUPPORTED | lessonSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getLessonSearchRecord | ||
| Description |
Gets the lesson search record corresponding to the
given lesson search record | ||
| Parameters | osid.type.Type | lessonSearchRecordType | a lesson search record type |
| Return | osid.course.plan.records.LessonSearchRecord | the lesson search record | |
| Errors | NULL_ARGUMENT | lessonSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(lessonSearchRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |