| Interface | osid.course.TermSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getTerms | ||
| Description |
Gets the term list resulting from a search. | ||
| Return | osid.course.TermList | the term list | |
| Errors | ILLEGAL_STATE | the term list has already been retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getTermQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.course.TermQueryInspector | the query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getTermSearchResultsRecord | ||
| Description |
Gets the term search results record corresponding to
the given term search record | ||
| Parameters | osid.type.Type | termSearchRecordType | a term search record type |
| Return | osid.course.records.TermSearchResultsRecord | the term search results record | |
| Errors | NULL_ARGUMENT | termSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(termSearchRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |