OSID Specifications
lexicon package
Version 3.1.0
lexicon package
Version 3.1.0
| Interface | osid.lexicon.IdiomSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidObjectSearchOrder | ||
osid.OsidSubjugateableSearchOrder | |||
| Used By | osid.lexicon.IdiomSearchSession | ||
osid.lexicon.IdiomSmartPressSession | |||
| Description |
An interface for specifying the ordering of search results. | ||
| Method | orderByText | ||
| Description |
Orders the results by text. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsTextSearchOrder | ||
| Description |
Tests if a text search order is available. | ||
| Return | boolean | true if a text search order is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getTextSearchOrder | ||
| Description |
Gets the text search order. | ||
| Return | osid.lexicon.TextSearchOrder | the text search order | |
| Errors | ILLEGAL_STATE | supportsTextSearchOrder() is false | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByLanguageType | ||
| Description |
Orders the results by language type. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByScriptType | ||
| Description |
Orders the results by script type. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByFormatType | ||
| Description |
Orders the results by format type. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByString | ||
| Description |
Orders the results by string. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getIdiomSearchOrderRecord | ||
| Description |
Gets the idiom search order record corresponding to
the given idiom record | ||
| Parameters | osid.type.Type | idiomRecordType | an idiom record type |
| Return | osid.lexicon.records.IdiomSearchOrderRecord | the idiom search order record | |
| Errors | NULL_ARGUMENT | idiomRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(idiomRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |