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

Interface	osid.mapping.route.MappingRouteManager
Implements	`osid.OsidManager`
Implements	`osid.mapping.route.MappingRouteProfile`
Description	The mapping route manager provides access to routing sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are: `RoutingSession:` a session to access routes to locations `RouteLookupSession:` a session to retrieve routes `RouteQuerySession:` a session to query for routes `RouteSearchSession:` a session to search for routes `RouteAdminSession:` a session to create and delete routes `RouteNotificationSession:` a session to receive notifications pertaining to route changes `RouteMapSession:` a session to looking locations of routes to maps `RouteMapAssignmentSession:` a session to manage route to map mappings `RouteSmartMapSession:` a session to manage dynamic maps of routes `ResourceRouteSession:` a session to find resources on routes `ResourceRouteAssignmentSession:` a session to manage resources on routes `ResourceRouteNotificationSession:` a session to subscribe to notifications of resources moving on routes `MyRouteSession:` a session to manage the route of the current user agent
Method	getRoutingSession
Description	Gets the `OsidSession` associated with the location routing service.
Return	`osid.mapping.route.RoutingSession`		a `RoutingSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsRouting()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRouting()` is `true.`
Method	getRoutingSessionForMap
Description	Gets the `OsidSession` associated with the location routing service for the given map.
Parameters	`osid.id.Id`	`mapId`	the `Id` of the `Map`
Return	`osid.mapping.route.RoutingSession`		a `RoutingSession`
Errors	NOT_FOUND		no map found by the given `Id`
	NULL_ARGUMENT		`mapId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRouting()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRouting()` and `supportsVisibleFederation()` are `true`
Method	getRouteLookupSession
Description	Gets the `OsidSession` associated with the route lookup service.
Return	`osid.mapping.route.RouteLookupSession`		a `RouteLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsRouteLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRouteLookup()` is `true.`
Method	getRouteLookupSessionForMap
Description	Gets the `OsidSession` associated with the route lookup service for the given map.
Parameters	`osid.id.Id`	`mapId`	the `Id` of the map
Return	`osid.mapping.route.RouteLookupSession`		a `RouteLookupSession`
Errors	NOT_FOUND		no `Map` found by the given `Id`
	NULL_ARGUMENT		`mapId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRouteLookup()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRouteLookup()` and `supportsVisibleFederation()` are `true`
Method	getRouteQuerySession
Description	Gets the `OsidSession` associated with the route query service.
Return	`osid.mapping.route.RouteQuerySession`		a `RouteQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsRouteQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRouteQuery()` is `true.`
Method	getRouteQuerySessionForMap
Description	Gets the `OsidSession` associated with the route query service for the given map.
Parameters	`osid.id.Id`	`mapId`	the `Id` of the map
Return	`osid.mapping.route.RouteQuerySession`		a `RouteQuerySession`
Errors	NOT_FOUND		no `Map` found by the given `Id`
	NULL_ARGUMENT		`mapId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRouteQuery()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRouteQuery()` and `supportsVisibleFederation()` are `true`
Method	getRouteSearchSession
Description	Gets the `OsidSession` associated with the route search service.
Return	`osid.mapping.route.RouteSearchSession`		a `RouteSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsRouteSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRouteSearch()` is `true.`
Method	getRouteSearchSessionForMap
Description	Gets the `OsidSession` associated with the route search service for the given map.
Parameters	`osid.id.Id`	`mapId`	the `Id` of the `Map`
Return	`osid.mapping.route.RouteSearchSession`		a `RouteSearchSession`
Errors	NOT_FOUND		no map found by the given `Id`
	NULL_ARGUMENT		`mapId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRouteSearch()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRouteSearch()` and `supportsVisibleFederation()` are `true`
Method	getRouteAdminSession
Description	Gets the `OsidSession` associated with the route administration service.
Return	`osid.mapping.route.RouteAdminSession`		a `RouteAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsRouteAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRouteAdmin()` is `true.`
Method	getRouteAdminSessionForMap
Description	Gets the `OsidSession` associated with the route administration service for the given map.
Parameters	`osid.id.Id`	`mapId`	the `Id` of the `Map`
Return	`osid.mapping.route.RouteAdminSession`		a `RouteAdminSession`
Errors	NOT_FOUND		no map found by the given `Id`
	NULL_ARGUMENT		`mapId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRouteAdmin()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRouteAdmin()` and `supportsVisibleFederation()` are `true`
Method	getRouteNotificationSession
Description	Gets the `OsidSession` associated with the route notification service.
Parameters	`osid.mapping.route.RouteReceiver`	`routeReceiver`	the notification callback
Return	`osid.mapping.route.RouteNotificationSession`		a `RouteNotificationSession`
Errors	NULL_ARGUMENT		`routeReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRouteNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRouteNotification()` is `true.`
Method	getRouteNotificationSessionForMap
Description	Gets the `OsidSession` associated with the route notification service for the given map.
Parameters	`osid.mapping.route.RouteReceiver`	`routeReceiver`	the notification callback
Parameters	`osid.id.Id`	`mapId`	the `Id` of the `Map`
Return	`osid.mapping.route.RouteNotificationSession`		a `RouteNotificationSession`
Errors	NOT_FOUND		no map found by the given `Id`
	NULL_ARGUMENT		`routeReceiver` or `mapId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRouteNotification()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRouteNotification()` and `supportsVisibleFederation()` are `true`
Method	getRouteMapSession
Description	Gets the `OsidSession` to lookup route/map mappings.
Return	`osid.mapping.route.RouteMapSession`		a `RouteMapSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsRouteMap()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRouteMap()` is `true.`
Method	getRouteMapAssignmentSession
Description	Gets the `OsidSession` associated with assigning routes to maps.
Return	`osid.mapping.route.RouteMapAssignmentSession`		a `LocationMapAssignmentSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsRouteMapAssignment()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRouteMapAssignment()` is `true.`
Method	getRouteSmartMapSession
Description	Gets the `OsidSession` to manage route smart maps.
Parameters	`osid.id.Id`	`mapId`	the `Id` of the `Map`
Return	`osid.mapping.route.RouteSmartMapSession`		a `RouteSmartMapSession`
Errors	NOT_FOUND		no map found by the given `Id`
	NULL_ARGUMENT		`mapId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsRouteSmartMap()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRouteSmartMap()` is `true.`
Method	getResourceRouteSession
Description	Gets the `OsidSession` associated with the resource route service.
Return	`osid.mapping.route.ResourceRouteSession`		a `ResourceRouteSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsResourceRoute()` is `false`
Compliance	`optional`		This method must be implemented if `supportsResourceRoute()` is `true.`
Method	getResourceRouteSessionForMap
Description	Gets the `OsidSession` associated with the resource route service for the given map.
Parameters	`osid.id.Id`	`mapId`	the `Id` of the `Map`
Return	`osid.mapping.route.ResourceRouteSession`		a `ResourceRouteSession`
Errors	NOT_FOUND		no map found by the given `Id`
	NULL_ARGUMENT		`mapId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsResourceRoute()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsResourceRoute()` and `supportsVisibleFederation()` are `true`
Method	getResourceRouteAssignmentSession
Description	Gets the `OsidSession` associated with the resource route assignment service.
Return	`osid.mapping.route.ResourceRouteAssignmentSession`		a `ResourceRouteAssignmentSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsResourceRouteAssignment()` is `false`
Compliance	`optional`		This method must be implemented if `supportsResourceRouteAssignment()` is `true.`
Method	getResourceRouteAssignmentSessionForMap
Description	Gets the `OsidSession` associated with the resource route assignment service for the given map.
Parameters	`osid.id.Id`	`mapId`	the `Id` of the `Map`
Return	`osid.mapping.route.ResourceRouteAssignmentSession`		a `ResourceRouteAssignmentSession`
Errors	NOT_FOUND		no map found by the given `Id`
	NULL_ARGUMENT		`mapId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsResourceRouteAssignment()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsResourceRouteAssignment()` and `supportsVisibleFederation()` are `true`
Method	getResourceRouteNotificationSession
Description	Gets the `OsidSession` associated with the resource route notification service.
Parameters	`osid.mapping.route.ResourceRouteReceiver`	`resourceRouteReceiver`	the notification callback
Return	`osid.mapping.route.ResourceRouteNotificationSession`		a `ResourceRouteNotificationSession`
Errors	NULL_ARGUMENT		`resourceRouteReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsResourceRouteNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsResourceRouteNotification()` is `true.`
Method	getResourceRouteNotificationSessionForMap
Description	Gets the `OsidSession` associated with the resource route notification service for the given map.
Parameters	`osid.mapping.route.ResourceRouteReceiver`	`resourceRouteReceiver`	the notification callback
Parameters	`osid.id.Id`	`mapId`	the `Id` of the `Map`
Return	`osid.mapping.route.ResourceRouteNotificationSession`		a `ResourceRouteNotificationSession`
Errors	NOT_FOUND		no map found by the given `Id`
	NULL_ARGUMENT		`resourceRouteReceiver` or `mapId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsResourceRouteNotification()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsResourceRouteNotification()` and `supportsVisibleFederation()` are `true`
Method	getMyRouteSession
Description	Gets the `OsidSession` associated with the my route service.
Return	`osid.mapping.route.MyRouteSession`		a `MyRouteLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsMyRouteLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsMyRouteLookup()` is `true.`
Method	getMyRouteSessionForMap
Description	Gets the `OsidSession` associated with the my route service for the given map.
Parameters	`osid.id.Id`	`mapId`	the `Id` of the map
Return	`osid.mapping.route.MyRouteSession`		a `MyRouteLookupSession`
Errors	NOT_FOUND		no `Map` found by the given `Id`
	NULL_ARGUMENT		`mapId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsMyRouteLookup()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsMyRouteLookup()` and `supportsVisibleFederation()` are `true`