| Interface | osid.mapping.route.RouteSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidRelationshipSearchOrder | ||
osid.OsidAggregateableSearchOrder | |||
| Description |
An interface for specifying the ordering of search results. | ||
| Method | orderByDistance | ||
| Description |
Specifies a preference for ordering the result set by the route distance. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByETA | ||
| Description |
Specifies a preference for ordering the result set by the route travel time. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRouteSearchOrderRecord | ||
| Description |
Gets the route order record corresponding to the given
route record | ||
| Parameters | osid.type.Type | routeRecordType | a route record type |
| Return | osid.mapping.route.records.RouteSearchOrderRecord | the route search order record | |
| Errors | NULL_ARGUMENT | routeRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(routeRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |