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

Interface	osid.mapping.route.RouteQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.mapping.route.RouteSearchSession`
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`. 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	getMapId
Description	Gets the `Map` `Id` associated with this session.
Return	`osid.id.Id`		the `Map Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getMap
Description	Gets the `Map` associated with this session.
Return	`osid.mapping.Map`		the map
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSearchRoutes
Description	Tests if this user can perform `Route` lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may not offer lookup operations to unauthorized users.
Return	`boolean`		`false` if search methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useFederatedMapView
Description	Federates the view for methods in this session. A federated view will include routes in maps which are children of this map in the map hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedMapView
Description	Isolates the view for methods in this session. An isolated view restricts searches to this map only.
Compliance	`mandatory`		This method is must be implemented.
Method	getRouteQuery
Description	Gets a route query.
Return	`osid.mapping.route.RouteQuery`		the route query
Compliance	`mandatory`		This method must be implemented.
Method	getRoutesByQuery
Description	Gets a list of `Routes` matching the given search.
Parameters	`osid.mapping.route.RouteQuery`	`routeQuery`	the route query
Return	`osid.mapping.route.RouteList`		the returned `RouteList`
Errors	NULL_ARGUMENT		`routeQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`routeQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.