Interface | osid.course.plan.LessonSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getLessons | ||
Description |
Gets the lesson list resulting from a search. | ||
Return | osid.course.plan.LessonList | the lesson list | |
Errors | ILLEGAL_STATE | list has already been retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getLessonQueryInspector | ||
Description |
Gets the inspector for the query to examine the terns used in the search. | ||
Return | osid.course.plan.LessonQueryInspector | the query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getLessonSearchResultsRecord | ||
Description |
Gets the lesson search results record corresponding to the given lesson search record Type. This method is used to retrieve an object implementing the requested record. | ||
Parameters | osid.type.Type | lessonSearchRecordType | a lesson search record type |
Return | osid.course.plan.records.LessonSearchResultsRecord | the lesson search results 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. |