OSID Specifications
control package
Version 3.1.0
control package
Version 3.1.0
| Interface | osid.control.InputSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidRuleSearchOrder | ||
| Used By | osid.control.InputSearchSession | ||
osid.control.InputSmartSystemSession | |||
| Description |
An interface for specifying the ordering of search results. | ||
| Method | orderByDevice | ||
| Description |
Orders the results by device. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsDeviceSearchOrder | ||
| Description |
Tests if a device search order is available. | ||
| Return | boolean | true if a device search order is available,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDeviceSearchOrder | ||
| Description |
Gets the device search order. | ||
| Return | osid.control.DeviceSearchOrder | the device search order | |
| Errors | ILLEGAL_STATE | supportsDeviceSearchOrder() is false | |
| Compliance | mandatory | This method must be implemented. | |
| 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 | getInputSearchOrderRecord | ||
| Description |
Gets the input search order record corresponding to
the given input record | ||
| Parameters | osid.type.Type | inputRecordType | an input record type |
| Return | osid.control.records.InputSearchOrderRecord | the input search order record | |
| Errors | NULL_ARGUMENT | inputRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(inputRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |