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

Interface	osid.mapping.route.RouteSmartMapSession
Implements	`osid.OsidSession`
Used By	`osid.mapping.route.MappingRouteManager`
Used By	`osid.mapping.route.MappingRouteProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `RouteQuery` can be retrieved from this session and mapped to this `Map` to create a virtual collection of `Routes`. The routes may be sequenced using the `RouteSearchOrder` from this session. This `Map` has a default query that matches any route and a default search order that specifies no sequencing. The queries may be examined using a `RouteQueryInspector`. The query may be modified by converting the inspector back to a `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	canManageSmartMaps
Description	Tests if this user can manage smart maps. A return of true does not guarantee successful authorization. A return of false indicates that it is known methods in this session will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer operations to unauthorized users.
Return	`boolean`		`false` if smart map management is not authorized, `true` otherwise
Compliance	`mandatory`		This method 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	getRouteSearchOrder
Description	Gets a route search order.
Return	`osid.mapping.route.RouteSearchOrder`		the route search order
Compliance	`mandatory`		This method must be implemented.
Method	applyRouteQuery
Description	Applies a route query to this map.
Parameters	`osid.mapping.route.RouteQuery`	`routeQuery`	the route query
Errors	NULL_ARGUMENT		`routeQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`routeQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectRouteQuery
Description	Gets a route query inspector for this map.
Return	`osid.mapping.route.RouteQueryInspector`		the route query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyRouteSequencing
Description	Applies a route search order to this map.
Parameters	`osid.mapping.route.RouteSearchOrder`	`routeSearchOrder`	the route search order
Errors	NULL_ARGUMENT		`routeSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`routeSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getRouteQueryFromInspector
Description	Gets a route query from an inspector.
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.