| Interface | osid.lexicon.TextSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Used By | osid.lexicon.TextSearchSession | ||
| Description |
The search interface for governing text searches. | ||
| Method | searchAmongTexts | ||
| Description |
Execute this search among the given list of texts. | ||
| Parameters | osid.id.IdList | textIds | list of texts |
| Errors | NULL_ARGUMENT | textIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderTextResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.lexicon.TextSearchOrder | textSearchOrder | text search order |
| Errors | NULL_ARGUMENT | textSearchOrder is null | |
| UNSUPPORTED | textSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getTextSearchRecord | ||
| Description |
Gets the text search record corresponding to the given
text search record | ||
| Parameters | osid.type.Type | textSearchRecordType | a text search record type |
| Return | osid.lexicon.records.TextSearchRecord | the text search 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. | |