public interface ControllerSearchOrder extends OsidObjectSearchOrder, OsidOperableSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and Description |
---|---|
ControllerSearchOrderRecord |
getControllerSearchOrderRecord(Type controllerRecordType)
Gets the controller search order record corresponding to the given
controller record
Type. |
ModelSearchOrder |
getModelSearchOrder()
Gets the model search order.
|
void |
orderByAddress(SearchOrderStyle style)
Orders the results by address.
|
void |
orderByDiscreetStates(SearchOrderStyle style)
Orders the results by the variable by discreet state capabilities.
|
void |
orderByModel(SearchOrderStyle style)
Orders the results by model.
|
void |
orderByToggleable(SearchOrderStyle style)
Orders the results by the toggles.
|
void |
orderByVariable(SearchOrderStyle style)
Orders the results by the variable capabilities.
|
void |
orderByVariableMaximum(SearchOrderStyle style)
Orders the results by variable maximum.
|
void |
orderByVariableMinimum(SearchOrderStyle style)
Orders the results by variable minimum.
|
void |
orderByVariablePercentage(SearchOrderStyle style)
Orders the results by the variable by percentage capabilities.
|
void |
orderByVersion(SearchOrderStyle style)
Orders the results by version.
|
boolean |
supportsModelSearchOrder()
Tests if a model search order is available.
|
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
orderByActive, orderByDisabled, orderByEnabled, orderByOperational
void orderByAddress(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByModel(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsModelSearchOrder()
true
if a model search order is available,
false
otherwisemandatory
- This method must be implemented. ModelSearchOrder getModelSearchOrder()
IllegalStateException
-
supportsModelSearchOrder()
is false
mandatory
- This method must be implemented. void orderByVersion(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByToggleable(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByVariable(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByVariablePercentage(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByVariableMinimum(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByVariableMaximum(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByDiscreetStates(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. ControllerSearchOrderRecord getControllerSearchOrderRecord(Type controllerRecordType) throws OperationFailedException
Type.
Multiple retrievals return the
same underlying object.controllerRecordType
- a controller record typeNullArgumentException
- controllerRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(controllerRecordType)
is false
mandatory
- This method must be implemented.