OSID Logo
OSID Specifications
mapping route package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.route.RouteSearchOrder
Implementsosid.OsidRelationshipSearchOrder
osid.OsidAggregateableSearchOrder
Description

An interface for specifying the ordering of search results.

MethodorderByDistance
Description

Specifies a preference for ordering the result set by the route distance.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByETA
Description

Specifies a preference for ordering the result set by the route travel time.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodgetRouteSearchOrderRecord
Description

Gets the route order record corresponding to the given route record Type. Multiple retrievals return the same underlying object.

Parametersosid.type.TyperouteRecordTypea route record type
Returnosid.mapping.route.records.RouteSearchOrderRecordthe route search order record
ErrorsNULL_ARGUMENT routeRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(routeRecordType) is false
CompliancemandatoryThis method must be implemented.