public interface InputSearchOrder extends OsidRuleSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and Description |
---|---|
ControllerSearchOrder |
getControllerSearchOrder()
Gets the controller search order.
|
DeviceSearchOrder |
getDeviceSearchOrder()
Gets the device search order.
|
InputSearchOrderRecord |
getInputSearchOrderRecord(Type inputRecordType)
Gets the input search order record corresponding to the given input
record
Type. |
void |
orderByController(SearchOrderStyle style)
Orders the results by controller.
|
void |
orderByDevice(SearchOrderStyle style)
Orders the results by device.
|
boolean |
supportsControllerSearchOrder()
Tests if a controller search order is available.
|
boolean |
supportsDeviceSearchOrder()
Tests if a device search order is available.
|
getRuleSearchOrder, orderByRule, supportsRuleSearchOrder
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
orderByActive, orderByDisabled, orderByEnabled, orderByOperational
void orderByDevice(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsDeviceSearchOrder()
true
if a device search order is available,
false
otherwisemandatory
- This method must be implemented. DeviceSearchOrder getDeviceSearchOrder()
IllegalStateException
-
supportsDeviceSearchOrder()
is false
mandatory
- This method must be implemented. void orderByController(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsControllerSearchOrder()
true
if a controller search order is available,
false
otherwisemandatory
- This method must be implemented. ControllerSearchOrder getControllerSearchOrder()
IllegalStateException
-
supportsControllerSearchOrder()
is false
mandatory
- This method must be implemented. InputSearchOrderRecord getInputSearchOrderRecord(Type inputRecordType) throws OperationFailedException
Type.
Multiple retrievals return the same
underlying object.inputRecordType
- an input record typeNullArgumentException
- inputRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(inputRecordType)
is false
mandatory
- This method must be implemented.