OSID - osid.mapping.route.RouteSearch Service Interface Definition

Interface	osid.mapping.route.RouteSearch
Implements	`osid.OsidSearch`
Used By	`osid.mapping.route.RouteSearchSession`
Description	The search interface for governing route searches.
Method	searchAmongRoutes
Description	Execute this search among the given list of routes.
Parameters	`osid.id.IdList`	`routeIds`	list of routes
Errors	NULL_ARGUMENT		`routeIds` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderRouteResults
Description	Specify an ordering to the search results.
Parameters	`osid.mapping.route.RouteSearchOrder`	`routeSearchOrder`	route search order
Errors	NULL_ARGUMENT		`routeSearchOrder` is `null`
Errors	UNSUPPORTED		`routeSearchOrder` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getRouteSearchRecord
Description	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	`osid.type.Type`	`routeSearchRecordType`	a route search record type
Return	`osid.mapping.route.records.RouteSearchRecord`		the route search record
Errors	NULL_ARGUMENT		`routeSearchRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(routeSearchRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.