Interface | osid.course.CourseCatalogSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getCourseCatalogs | ||
Description |
Gets the course catalog list resulting from a search. | ||
Return | osid.course.CourseCatalogList | the course catalog list | |
Errors | ILLEGAL_STATE | the course catalog list has already been retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getCourseCatalogQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.course.CourseCatalogQueryInspector | the query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getCourseCatalogSearchResultsRecord | ||
Description |
Gets the course catalog search results record
corresponding to the given course catalog search record
| ||
Parameters | osid.type.Type | courseCatalogSearchRecordType | a course catalog search record type |
Return | osid.course.records.CourseCatalogSearchResultsRecord | the course catalog search results record | |
Errors | NULL_ARGUMENT | courseCatalogSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(courseCatalogSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |