public interface SignalSearchOrder extends OsidRuleSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and Description |
---|---|
PathSearchOrder |
getPathSearchOrder()
Gets a path search order.
|
SignalSearchOrderRecord |
getSignalSearchOrderRecord(Type signalRecordType)
Gets the signal search order record corresponding to the given signal
record
Type. |
void |
orderByPath(SearchOrderStyle style)
Specifies a preference for ordering the results by path.
|
boolean |
supportsPathSearchOrder()
Tests if a search order for the path is available.
|
getRuleSearchOrder, orderByRule, supportsRuleSearchOrder
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
orderByActive, orderByDisabled, orderByEnabled, orderByOperational
void orderByPath(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsPathSearchOrder()
true
if a path search order is available,
false
otherwisemandatory
- This method must be implemented. PathSearchOrder getPathSearchOrder()
UnimplementedException
-
supportsPathSearchOrder()
is false
optional
- This method must be implemented if
supportsPathSearchOrder()
is true.
SignalSearchOrderRecord getSignalSearchOrderRecord(Type signalRecordType) throws OperationFailedException
Type.
Multiple retrievals return the same
underlying object.signalRecordType
- a signal record typeNullArgumentException
- signalRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(signalRecordType)
is false
mandatory
- This method must be implemented.