Interface RouteSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface RouteSearch
extends OsidSearch

The search interface for governing route searches.

Method Summary

Modifier and Type	Method	Description
RouteSearchRecord	getRouteSearchRecord(Type routeSearchRecordType)	Gets the route search record corresponding to the given route search record Type.
void	orderRouteResults(RouteSearchOrder routeSearchOrder)	Specify an ordering to the search results.
void	searchAmongRoutes(IdList routeIds)	Execute this search among the given list of routes.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type.

Methods inherited from interface OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

Method Details

searchAmongRoutes

void searchAmongRoutes(IdList routeIds)

Execute this search among the given list of routes.

Parameters:

routeIds - list of routes

Throws:

NullArgumentException - routeIds is null

Compliance:

mandatory - This method must be implemented.

orderRouteResults

void orderRouteResults(RouteSearchOrder routeSearchOrder)

Specify an ordering to the search results.

Parameters:

routeSearchOrder - route search order

Throws:

NullArgumentException - routeSearchOrder is null

UnsupportedException - routeSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getRouteSearchRecord

RouteSearchRecord getRouteSearchRecord(Type routeSearchRecordType)
                                throws OperationFailedException

Gets the route search record corresponding to the given route search record Type. This method is used to retrieve an object implementing the requested record.

Parameters:

routeSearchRecordType - a route search record type

Returns:

the route search record

Throws:

NullArgumentException - routeSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(routeSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.