public interface SettingSearchOrder extends OsidObjectSearchOrder, OsidSubjugateableSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and Description |
---|---|
ControllerSearchOrder |
getControllerSearchOrder()
Gets the controller search order.
|
StateSearchOrder |
getDiscreetStateSearchOrder()
Gets the state search order.
|
SettingSearchOrderRecord |
getSettingSearchOrderRecord(Type settingRecordType)
Gets the setting search order record corresponding to the given
setting record
Type. |
void |
orderByController(SearchOrderStyle style)
Orders the results by controller.
|
void |
orderByDiscreetState(SearchOrderStyle style)
Orders the results by variable discreet state.
|
void |
orderByOff(SearchOrderStyle style)
Orders the results by off status,
|
void |
orderByOn(SearchOrderStyle style)
Orders the results by on status.
|
void |
orderByRampRate(SearchOrderStyle style)
Orders the results by ramp rate.
|
void |
orderByVariableAmount(SearchOrderStyle style)
Orders the results by variable amount.
|
void |
orderByVariablePercentage(SearchOrderStyle style)
Orders the results by variable percentage.
|
boolean |
supportsControllerSearchOrder()
Tests if a controller search order is available.
|
boolean |
supportsDiscreetStateSearchOrder()
Tests if a state search order is available.
|
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
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. void orderByOn(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByOff(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 orderByVariableAmount(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByDiscreetState(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsDiscreetStateSearchOrder()
true
if a state search order is available,
false
otherwisemandatory
- This method must be implemented. StateSearchOrder getDiscreetStateSearchOrder()
IllegalStateException
-
supportsDiscreetStateSearchOrder()
is false
mandatory
- This method must be implemented. void orderByRampRate(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. SettingSearchOrderRecord getSettingSearchOrderRecord(Type settingRecordType) throws OperationFailedException
Type.
Multiple retrievals return the
same underlying object.settingRecordType
- a setting record typeNullArgumentException
- settingRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(settingRecordType)
is false
mandatory
- This method must be implemented.