OSID Specifications
control package
Version 3.0.0
Release Candidate Preview
control package
Version 3.0.0
Release Candidate Preview
| Interface | osid.control.ControllerSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidObjectSearchOrder | ||
osid.OsidOperableSearchOrder | |||
| Description |
An interface for specifying the ordering of search results. | ||
| Method | orderByAddress | ||
| Description |
Orders the results by address. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByModel | ||
| Description |
Orders the results by model. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsModelSearchOrder | ||
| Description |
Tests if a model search order is available. | ||
| Return | boolean | true if a model search order is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getModelSearchOrder | ||
| Description |
Gets the model search order. | ||
| Return | osid.inventory.ModelSearchOrder | the model search order | |
| Errors | ILLEGAL_STATE | supportsModelSearchOrder() is false | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByVersion | ||
| Description |
Orders the results by version. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByToggleable | ||
| Description |
Orders the results by the toggles. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByVariable | ||
| Description |
Orders the results by the variable capabilities. | ||
| 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 the variable by percentage capabilities. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByVariableMinimum | ||
| Description |
Orders the results by variable minimum. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByVariableMaximum | ||
| Description |
Orders the results by variable maximum. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByDiscreetStates | ||
| Description |
Orders the results by the variable by discreet state capabilities. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getControllerSearchOrderRecord | ||
| Description |
Gets the controller search order record corresponding
to the given controller record | ||
| Parameters | osid.type.Type | controllerRecordType | a controller record type |
| Return | osid.control.records.ControllerSearchOrderRecord | the controller search order record | |
| Errors | NULL_ARGUMENT | controllerRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(controllerRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |