| Interface | osid.lexicon.TextSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Used By | osid.lexicon.TextSearchSession | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getTexts | ||
| Description |
Gets the text list resulting from a search. | ||
| Return | osid.lexicon.TextList | the text list | |
| Errors | ILLEGAL_STATE | list already retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getTextQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.lexicon.TextQueryInspector | the text query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getTextSearchResultsRecord | ||
| Description |
Gets the text search results record corresponding to
the given text search record | ||
| Parameters | osid.type.Type | textSearchRecordType | a text search record type |
| Return | osid.lexicon.records.TextSearchResultsRecord | the text search results record | |
| Errors | NULL_ARGUMENT | textSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(textSearchRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |