Interface | osid.course.chronicle.CourseEntrySearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getCourseEntries | ||
Description |
Gets the course list resulting from a search. | ||
Return | osid.course.chronicle.CourseEntryList | the course entry list | |
Errors | ILLEGAL_STATE | the course entry list has already been retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getCourseEntryQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.course.chronicle.CourseEntryQueryInspector | the query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getCourseEntrySearchResultsRecord | ||
Description |
Gets the course entry search results record
corresponding to the given course entry search record
| ||
Parameters | osid.type.Type | courseEntrySearchRecordType | a course entry search record type |
Return | osid.course.chronicle.records.CourseEntrySearchResultsRecord | the course entry search results record | |
Errors | NULL_ARGUMENT | courseEntrySearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(courseEntrySearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |