| Interface | osid.lexicon.IdiomSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Used By | osid.lexicon.IdiomSearchSession | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getIdioms | ||
| Description |
Gets the idiom list resulting from a search. | ||
| Return | osid.lexicon.IdiomList | the idiom list | |
| Errors | ILLEGAL_STATE | list already retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getIdiomQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.lexicon.IdiomQueryInspector | the idiom query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getIdiomSearchResultsRecord | ||
| Description |
Gets the idiom search results record corresponding to
the given idiom search record | ||
| Parameters | osid.type.Type | idiomSearchRecordType | an idiom search record type |
| Return | osid.lexicon.records.IdiomSearchResultsRecord | the idiom search results record | |
| Errors | NULL_ARGUMENT | idiomSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(idiomSearchRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |