org.osid.mapping.route

Interface RouteSearchOrder

All Superinterfaces:

Extensible, OsidAggregateableSearchOrder, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidRelationshipSearchOrder, OsidSearchOrder, OsidTemporalSearchOrder, Suppliable

public interface RouteSearchOrder
extends OsidRelationshipSearchOrder, OsidAggregateableSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidRelationshipSearchOrder

getEndReasonSearchOrder, orderByEndReason, supportsEndReasonSearchOrder

Methods inherited from interface org.osid.OsidObjectSearchOrder

orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic

Methods inherited from interface org.osid.OsidIdentifiableSearchOrder

orderById

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidTemporalSearchOrder

orderByEffective, orderByEndDate, orderByStartDate

Method Detail

orderByDistance

void orderByDistance(SearchOrderStyle style)

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

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByETA

void orderByETA(SearchOrderStyle style)

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

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getRouteSearchOrderRecord

RouteSearchOrderRecord getRouteSearchOrderRecord(Type routeRecordType)
                                                 throws OperationFailedException

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

Parameters:

routeRecordType - a route record type

Returns:

the route search order record

Throws:

NullArgumentException - routeRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(routeRecordType) is false

Compliance:

mandatory - This method must be implemented.