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

Interface	osid.mapping.route.RouteSearchSession
Implements	`osid.mapping.route.RouteQuerySession`
Used By	`osid.mapping.route.MappingRouteManager`
Used By	`osid.mapping.route.MappingRouteProxyManager`
Description	This session provides methods for searching among `Routes`. The search query is constructed using the `RouteQuery`. `getRoutesByQuery()` is the basic search method and returns a list of `Routes`. A more advanced search may be performed with `getRoutesBySearch()`. It accepts a `RouteSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getRoutesBySearch()` returns a `RouteSearchResults` that can be used to access the resulting `RouteList` or be used to perform a search within the result set through `RouteSearch`. This session defines views that offer differing behaviors for searching. federated map view: searches include routes in maps of which this map is an ancestor in the map hierarchy isolated map view: searches are restricted to routes in this map Routes may have a query record indicated by their respective record types. The query record is accessed via the `RouteQuery`.
Method	getRouteSearch
Description	Gets a route search.
Return	`osid.mapping.route.RouteSearch`		the route search
Compliance	`mandatory`		This method must be implemented.
Method	getRouteSearchOrder
Description	Gets a route search order. The `RouteSearchOrder` is supplied to a `RouteSearch` to specify the ordering of results.
Return	`osid.mapping.route.RouteSearchOrder`		the route search order
Compliance	`mandatory`		This method must be implemented.
Method	getRoutesBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.mapping.route.RouteQuery`	`routeQuery`	the route query
Parameters	`osid.mapping.route.RouteSearch`	`routeSearch`	the route search
Return	`osid.mapping.route.RouteSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`routeQuery` or `routeSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`routeQuery` or `routeSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getRouteQueryFromInspector
Description	Gets a route query from an inspector. The inspector is available from a `RouteSearchResults`.
Parameters	`osid.mapping.route.RouteQueryInspector`	`routeQueryInspector`	a route query inspector
Return	`osid.mapping.route.RouteQuery`		the route query
Errors	NULL_ARGUMENT		`routeQueryInspector` is `null`
Errors	UNSUPPORTED		`routeQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.