OSID Specifications
control package
Version 3.0.0
Release Candidate Preview
control package
Version 3.0.0
Release Candidate Preview
| Interface | osid.control.SettingSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidObjectSearchOrder | ||
osid.OsidSubjugateableSearchOrder | |||
| Description |
An interface for specifying the ordering of search results. | ||
| Method | orderByController | ||
| Description |
Orders the results by controller. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsControllerSearchOrder | ||
| Description |
Tests if a controller search order is available. | ||
| Return | boolean | true if a controller search order is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getControllerSearchOrder | ||
| Description |
Gets the controller search order. | ||
| Return | osid.control.ControllerSearchOrder | the controller search order | |
| Errors | ILLEGAL_STATE | supportsControllerSearchOrder() is false | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByOn | ||
| Description |
Orders the results by on status. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByOff | ||
| Description |
Orders the results by off status, | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByVariablePercentage | ||
| Description |
Orders the results by variable percentage. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByVariableAmount | ||
| Description |
Orders the results by variable amount. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByDiscreetState | ||
| Description |
Orders the results by variable discreet state. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsDiscreetStateSearchOrder | ||
| Description |
Tests if a state search order is available. | ||
| Return | boolean | true if a state search order is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDiscreetStateSearchOrder | ||
| Description |
Gets the state search order. | ||
| Return | osid.process.StateSearchOrder | the state search order | |
| Errors | ILLEGAL_STATE | supportsDiscreetStateSearchOrder() is false | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByRampRate | ||
| Description |
Orders the results by ramp rate. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getSettingSearchOrderRecord | ||
| Description |
Gets the setting search order record corresponding to
the given setting record | ||
| Parameters | osid.type.Type | settingRecordType | a setting record type |
| Return | osid.control.records.SettingSearchOrderRecord | the setting order record interface | |
| Errors | NULL_ARGUMENT | settingRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(settingRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |