| Interface | osid.lexicon.ParameterSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidObjectSearchOrder | ||
osid.OsidSubjugateableSearchOrder | |||
| Used By | osid.lexicon.ParameterSearchSession | ||
osid.lexicon.ParameterSmartPressSession | |||
| Description |
An interface for specifying the ordering of search results. | ||
| Method | orderBySyntax | ||
| Description |
Orders the results by syntax. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByInputPosition | ||
| Description |
Orders the results by input position. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getParameterSearchOrderRecord | ||
| Description |
Gets the parameter search order record corresponding to
the given parameter record | ||
| Parameters | osid.type.Type | parameterRecordType | a parameter record type |
| Return | osid.lexicon.records.ParameterSearchOrderRecord | the parameter search order record | |
| Errors | NULL_ARGUMENT | parameterRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(parameterRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |