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

Interface	osid.mapping.route.ResourceRouteNotificationSession
Implements	`osid.OsidSession`
Description	This session defines methods to receive notifications on adds/changes to resources on routes in this `Map.` 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.
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	canRegisterForResourceRouteNotifications
Description	Tests if this user can register for 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 locations 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	reliableResourceRouteNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeResourceRouteNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableResourceRouteNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeResourceRouteNotification
Description	Acknowledge a resource 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	registerForStartedRoutes
Description	Register for notifications of new routes for a resource. `ResourceRouteReceiver.startedRoute()` is invoked when a resource begins a route.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForStartedRoute
Description	Register for notifications of a started route. `ResourceRouteReceiver.startedRoute()` is invoked when a resource begins the specified route.
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	registerForStartedRoutesByStartingLocation
Description	Register for notifications of a started route from the specified location. `ResourceRouteReceiver.startedRoute()` is invoked when the specified resource begins a route.
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	registerForStartedRoutesByEndingLocation
Description	Register for notifications of a started route to the specified location. `ResourceRouteReceiver.startedRoute()` is invoked when the specified resource begins a route.
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	registerForStartedRoutesForResource
Description	Register for notifications of a started route for the given resource. `ResourceRouteReceiver.startedRoute()` is invoked when the specified resource begins a route.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the `Resource` to monitor
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForStartedRoutesForResourcesByGenusType
Description	Register for notifications of a started route for resources of the given resource genus type. `ResourceRouteReceiver.startedRoute()` is invoked when the specified resource begins a route.
Parameters	`osid.type.Type`	`resourceGenusType`	the genus type of the `Resource` to monitor
Errors	NULL_ARGUMENT		`resourceGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForCompletedRoutes
Description	Registers for notification of completed routes. `ResourceRouteReceiver.completedRoute()` is invoked when a resource completes a route.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForCompletedRoute
Description	Register for notifications of a completed route. `ResourceRouteReceiver.completedRoute()` is invoked when a resource completes the specified route.
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	registerForCompletedRoutesByStartingLocation
Description	Registers for notification of a completed route from the specified starting location. `ResourceRouteReceiver.completedRoute()` is invoked when the specified resource completes a route.
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	registerForCompletedRoutesByEndingLocation
Description	Registers for notification of a completed route from the specified ending location. `ResourceRouteReceiver.completedRoute()` is invoked when the specified resource completes a route.
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	registerForCompletedRoutesForResource
Description	Registers for notification of a completed route for the given resource. `ResourceRouteReceiver.completedRoute()` is invoked when the specified resource completes a route.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the `Resource` to monitor
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForCompletedRoutesForResourcesByGenusType
Description	Registers for notification of a completed route for resources of the given resource genus type. `ResourceRouteReceiver.completedRoute()` is invoked when the specified resource completes a route.
Parameters	`osid.type.Type`	`resourceGenusType`	the genus type of the `Resource` to monitor
Errors	NULL_ARGUMENT		`resourceGenusTYpe` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForCancelledRoutes
Description	Registers for notification of cancelled routes. `ResourceRouteReceiver.cancelledRoute()` is invoked when a resource cancels a route.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForCancelledRoute
Description	Register for notifications of a cancelled route. `ResourceRouteReceiver.completedRoute()` is invoked when a resource cancels the specified route.
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	registerForCancelledRoutesByStartingLocation
Description	Registers for notification of cancelled routes from the specified starting location. `ResourceRouteReceiver.cancelledRoute()` is invoked when a specified resource cancels a route.
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	registerForCancelledRoutesByEndingLocation
Description	Registers for notification of cancelled routes from the specified ending location. `ResourceRouteReceiver.cancelledRoute()` is invoked when a specified resource cancels a route.
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	registerForCancelledRoutesForResource
Description	Registers for notification of cancelled routes for the given resource. `ResourceRouteReceiver.cancelledRoute()` is invoked when a specified resource cancels a route.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the `Resource` to monitor
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForCancelledRoutesForResourcesByGenusType
Description	Registers for notification of cancelled routes for resources of the given resource genus type. `ResourceRouteReceiver.cancelledRoute()` is invoked when a specified resource cancels a route.
Parameters	`osid.type.Type`	`resourceGenusType`	the genus type of the `Resource` to monitor
Errors	NULL_ARGUMENT		`resourceGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewRouteSegments
Description	Registers for notification of new route segments. `ResourceRouteReceiver.newRouteSegment()` is invoked when a resource moves on to a new route segment.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewRouteSegment
Description	Registers for notification of new route segments. `ResourceRouteReceiver.newRouteSegment()` is invoked when a resource moves on to the desigtnated route segment.
Parameters	`osid.id.Id`	`routeSegmentId`	the `Id` of the `RouteSegment` to monitor
Errors	NULL_ARGUMENT		`routeSegmentId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewRouteSegmentsForResource
Description	Registers for notification of new route segments for the given resource. `ResourceRouteReceiver.newRouteSegment()` is invoked when the specified resource moves on to a new route segment.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the `Resource` to monitor
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewRouteSegmentsForResourcesByGenusType
Description	Registers for notification of new route segments for resources of the given genus type. `ResourceRouteReceiver.newRouteSegment()` is invoked when the specified resource moves on to a new route segment.
Parameters	`osid.type.Type`	`resourceGenusType`	the genus type of the `Resource` to monitor
Errors	NULL_ARGUMENT		`resourceGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.