Interface | osid.course.CourseSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getCourses | ||
Description |
Gets the course list resulting from a search. | ||
Return | osid.course.CourseList | the course list | |
Errors | ILLEGAL_STATE | the course list has already been retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getCourseQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.course.CourseQueryInspector | the query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getCourseSearchResultsRecord | ||
Description |
Gets the course search results record corresponding to
the given course search record | ||
Parameters | osid.type.Type | courseSearchRecordType | a course search record type |
Return | osid.course.records.CourseSearchResultsRecord | the course search results record | |
Errors | NULL_ARGUMENT | courseSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(courseSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |