public interface ProcessSearchOrder extends OsidGovernatorSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and Description |
---|---|
StateSearchOrder |
getInitialStateSearchOrder()
Gets the initial state search order.
|
StepSearchOrder |
getInitialStepSearchOrder()
Gets the initial step search order.
|
ProcessSearchOrderRecord |
getProcessSearchOrderRecord(Type processRecordType)
Gets the process search order record corresponding to the given
process record
Type. |
void |
orderByEnabled(SearchOrderStyle style)
Orders the results by enabled.
|
void |
orderByInitialState(SearchOrderStyle style)
Orders the results by initial state.
|
void |
orderByInitialStep(SearchOrderStyle style)
Orders the results by initial step.
|
boolean |
supportsInitialStateSearchOrder()
Tests if an initial state search order is available.
|
boolean |
supportsInitialStepSearchOrder()
Tests if an initial step search order is available.
|
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
orderByActive, orderByDisabled, orderByOperational
getProviderSearchOrder, orderByProvider, supportsProviderSearchOrder
void orderByEnabled(SearchOrderStyle style)
orderByEnabled
in interface OsidOperableSearchOrder
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByInitialStep(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsInitialStepSearchOrder()
true
if a step search order is available,
false
otherwisemandatory
- This method must be implemented. StepSearchOrder getInitialStepSearchOrder()
IllegalStateException
-
supportsInitialStepSearchOrder()
is false
mandatory
- This method must be implemented. void orderByInitialState(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsInitialStateSearchOrder()
true
if a state search order is available,
false
otherwisemandatory
- This method must be implemented. StateSearchOrder getInitialStateSearchOrder()
IllegalStateException
-
supportsInitialStateSearchOrder()
is false
mandatory
- This method must be implemented. ProcessSearchOrderRecord getProcessSearchOrderRecord(Type processRecordType) throws OperationFailedException
Type.
Multiple retrievals return the
same underlying object.processRecordType
- a process record typeNullArgumentException
- processRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(processRecordType)
is false
mandatory
- This method must be implemented.