| Interface | osid.lexicon.IdiomSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Used By | osid.lexicon.IdiomSearchSession | ||
| Description |
The search interface for governing idiom searches. | ||
| Method | searchAmongIdioms | ||
| Description |
Execute this search among the given list of idioms. | ||
| Parameters | osid.id.IdList | idiomIds | list of idioms |
| Errors | NULL_ARGUMENT | idiomIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderIdiomResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.lexicon.IdiomSearchOrder | idiomSearchOrder | idiom search order |
| Errors | NULL_ARGUMENT | idiomSearchOrder is null | |
| UNSUPPORTED | idiomSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getIdiomSearchRecord | ||
| Description |
Gets the idiom search record corresponding to the given
idiom search record | ||
| Parameters | osid.type.Type | idiomSearchRecordType | an idiom search record type |
| Return | osid.lexicon.records.IdiomSearchRecord | the idiom search 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. | |