public interface RouteSegmentSearchOrder extends OsidObjectSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and Description |
---|---|
PathSearchOrder |
getPathSearchOrder()
Gets a path search order.
|
RouteSearchOrder |
getRouteSearchOrder()
Gets a route search order.
|
RouteSegmentSearchOrderRecord |
getRouteSegmentSearchOrderRecord(Type routeSegmentRecordType)
Gets the route segment search order record corresponding to the given
route segment
Type. |
void |
orderByDistance(SearchOrderStyle style)
Specifies a preference for oredering the results by distance.
|
void |
orderByEndingInstructions(SearchOrderStyle style)
Specifies a preference for oredering the results by ending
instructions.
|
void |
orderByETA(SearchOrderStyle style)
Specifies a preference for oredering the results by estimated travel
time.
|
void |
orderByPath(SearchOrderStyle style)
Specifies a preference for oredering the results by path.
|
void |
orderByRoute(SearchOrderStyle style)
Specifies a preference for oredering the results by path.
|
void |
orderByStartingInstructions(SearchOrderStyle style)
Specifies a preference for oredering the results by starting
instructions.
|
boolean |
supportsPathSearchOrder()
Tests if a search order for the path is available.
|
boolean |
supportsRouteSearchOrder()
Tests if a search order for the route is available.
|
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
void orderByStartingInstructions(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByEndingInstructions(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. 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. void orderByRoute(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsRouteSearchOrder()
true
if a route search order is available,
false
otherwisemandatory
- This method must be implemented. RouteSearchOrder getRouteSearchOrder()
UnimplementedException
-
supportsRouteSearchOrder()
is false
optional
- This method must be implemented if
supportsRouteSearchOrder()
is true.
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.
RouteSegmentSearchOrderRecord getRouteSegmentSearchOrderRecord(Type routeSegmentRecordType) throws OperationFailedException
Type.
Multiple retrievals return the same
underlying object.routeSegmentRecordType
- a route segment record typeNullArgumentException
- routeSegmentRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(routeSegmentRecordType)
is false
mandatory
- This method must be implemented.