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

Interface	osid.mapping.route.RouteNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.mapping.route.MappingRouteManager`
Used By	`osid.mapping.route.MappingRouteProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `Routes` in this `Map`. This also includes existing routes that may appear or disappear due to changes in the `Map` hierarchy, This session is intended for consumers needing to synchronize their state with this service without the use of polling. Notifications are cancelled when this session is closed. The two views defined in this session correspond to the views in the `RouteLookupSession`.
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	canRegisterForRouteNotifications
Description	Tests if this user can register for `Route` notifications. 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 opt not to offer notification operations.
Return	`boolean`		`false` if notification 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 notifications to this map only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliableRouteNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeRouteNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableRouteNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeRouteNotification
Description	Acknowledge a route notification.
Parameters	`osid.id.Id`	`notificationId`	the `Id` of the notification
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewRoutes
Description	Register for notifications of new routes. `RouteReceiver.newRoutes()` is invoked when a new `Route` appears in this map.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewRoutesForStartingLocation
Description	Register for notifications of new routes for the given starting location. `RouteReceiver.newRoutes()` is invoked when a new `Route` appears in this map.
Parameters	`osid.id.Id`	`startingLocationId`	the `Id` of the `Location` to monitor
Errors	NULL_ARGUMENT		`startingLocationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewRoutesForEndingLocation
Description	Register for notifications of new routes for the given ending location. `RouteReceiver.newRoutes()` is invoked when a new `Route` appears in this map.
Parameters	`osid.id.Id`	`endingLocationId`	the `Id` of the `Location` to monitor
Errors	NULL_ARGUMENT		`endingLocationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewRoutesThroughLocation
Description	Register for notifications of new routes through the given location. `RouteReceiver.newRoutes()` is invoked when a new `Route` appears in this map.
Parameters	`osid.id.Id`	`locationId`	the `Id` of the `Location` to monitor
Errors	NULL_ARGUMENT		`locationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedRoutes
Description	Registers for notification of updated routes. `RouteReceiver.changedRoutes()` is invoked when a route in this map is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedRoutesForStartingLocation
Description	Register for notifications of updated routes for the given starting location. `RouteReceiver.updatedRoutes()` is invoked when a route is changed in this map.
Parameters	`osid.id.Id`	`startingLocationId`	the `Id` of the `Location` to monitor
Errors	NULL_ARGUMENT		`startingLocationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedRoutesForEndingLocation
Description	Register for notifications of updated routes for the given ending location. `RouteReceiver.changedRoutes()` is invoked when a route is changed in this map.
Parameters	`osid.id.Id`	`endingLocationId`	the `Id` of the `Location` to monitor
Errors	NULL_ARGUMENT		`endingLocationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedRoutesThroughLocation
Description	Register for notifications of updated routes through the given location. `RouteReceiver.changedRoutes()` is invoked when a route is changed in this map.
Parameters	`osid.id.Id`	`locationId`	the `Id` of the `Location` to monitor
Errors	NULL_ARGUMENT		`locationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedRoute
Description	Registers for notification of an updated route. `RouteReceiver.changedRoutes()` is invoked when the specified route in this map is changed.
Parameters	`osid.id.Id`	`routeId`	the `Id` of the `Route` to monitor
Errors	NULL_ARGUMENT		`routeId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedRoutes
Description	Registers for notification of deleted routes. `RouteReceiver.deletedRoutes()` is invoked when a route is deleted or removed from this map.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedRoutesForStartingLocation
Description	Register for notifications of deleted routes for the given starting location. `RouteReceiver.deletedRoutes()` is invoked when a route is removed from this map.
Parameters	`osid.id.Id`	`startingLocationId`	the `Id` of the `Location` to monitor
Errors	NULL_ARGUMENT		`startingLocationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedRoutesForEndingLocation
Description	Register for notifications of deleted routes for the given ending location. `RouteReceiver.deletedRoutes()` is invoked when a route is removed from this map.
Parameters	`osid.id.Id`	`endingLocationId`	the `Id` of the `Location` to monitor
Errors	NULL_ARGUMENT		`endingLocationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedRoutesThroughLocation
Description	Register for notifications of deleted routes through the given location. `RouteReceiver.deletedRoutes()` is invoked when a route is removed from this map.
Parameters	`osid.id.Id`	`locationId`	the `Id` of the `Location` to monitor
Errors	NULL_ARGUMENT		`locationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedRoute
Description	Registers for notification of a deleted route. `RouteReceiver.deletedRoutes()` is invoked when the specified route is deleted or removed from this map.
Parameters	`osid.id.Id`	`routeId`	the `Id` of the `Route` to monitor
Errors	NULL_ARGUMENT		`routeId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.