public interface ObstacleSearchOrder extends OsidObjectSearchOrder, OsidOperableSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and Description |
---|---|
ObstacleSearchOrderRecord |
getObstacleSearchOrderRecord(Type obstacleRecordType)
Gets the obstacle search order record corresponding to the given
obstacle record
Type. |
PathSearchOrder |
getPathSearchOrder()
Gets a path search order.
|
void |
orderByLength(SearchOrderStyle style)
Orders the results by the length of the obstacle.
|
void |
orderByPath(SearchOrderStyle style)
Orders the results by path.
|
boolean |
supportsPathSearchOrder()
Tests if a path search order is available.
|
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.
void orderByLength(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. ObstacleSearchOrderRecord getObstacleSearchOrderRecord(Type obstacleRecordType) throws OperationFailedException
Type.
Multiple retrievals return the
same underlying object.obstacleRecordType
- an obstacle record typeNullArgumentException
- obstacleRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(obstacleRecordType)
is false
mandatory
- This method must be implemented.