public interface RouteSearchOrder extends OsidRelationshipSearchOrder, OsidAggregateableSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and Description |
---|---|
RouteSearchOrderRecord |
getRouteSearchOrderRecord(Type routeRecordType)
Gets the route order record corresponding to the given route record
Type. |
void |
orderByDistance(SearchOrderStyle style)
Specifies a preference for ordering the result set by the route
distance.
|
void |
orderByETA(SearchOrderStyle style)
Specifies a preference for ordering the result set by the route travel
time.
|
getEndReasonSearchOrder, orderByEndReason, supportsEndReasonSearchOrder
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
orderByEffective, orderByEndDate, orderByStartDate
void orderByDistance(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByETA(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. RouteSearchOrderRecord getRouteSearchOrderRecord(Type routeRecordType) throws OperationFailedException
Type.
Multiple retrievals return the same underlying
object.routeRecordType
- a route record typeNullArgumentException
- routeRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(routeRecordType)
is false
mandatory
- This method must be implemented.