public interface RouteNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to Route
objects 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.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeRouteNotification(Id notificationId)
Acknowledge a route notification.
|
boolean |
canRegisterForRouteNotifications()
Tests if this user can register for
Route
notifications. |
Map |
getMap()
Gets the
Map associated with this session. |
Id |
getMapId()
Gets the
Map Id associated with this
session. |
void |
registerForChangedRoute(Id routeId)
Registers for notification of an updated route.
|
void |
registerForChangedRoutes()
Registers for notification of updated routes.
|
void |
registerForChangedRoutesForEndingLocation(Id endingLocationId)
Register for notifications of updated routes for the given ending
location.
|
void |
registerForChangedRoutesForStartingLocation(Id startingLocationId)
Register for notifications of updated routes for the given starting
location.
|
void |
registerForChangedRoutesThroughLocation(Id locationId)
Register for notifications of updated routes through the given
location.
|
void |
registerForDeletedRoute(Id routeId)
Registers for notification of a deleted route.
|
void |
registerForDeletedRoutes()
Registers for notification of deleted routes.
|
void |
registerForDeletedRoutesForEndingLocation(Id endingLocationId)
Register for notifications of deleted routes for the given ending
location.
|
void |
registerForDeletedRoutesForStartingLocation(Id startingLocationId)
Register for notifications of deleted routes for the given starting
location.
|
void |
registerForDeletedRoutesThroughLocation(Id locationId)
Register for notifications of deleted routes through the given
location.
|
void |
registerForNewRoutes()
Register for notifications of new routes.
|
void |
registerForNewRoutesForEndingLocation(Id endingLocationId)
Register for notifications of new routes for the given ending
location.
|
void |
registerForNewRoutesForStartingLocation(Id startingLocationId)
Register for notifications of new routes for the given starting
location.
|
void |
registerForNewRoutesThroughLocation(Id locationId)
Register for notifications of new routes through the given location.
|
void |
reliableRouteNotifications()
Reliable notifications are desired.
|
void |
unreliableRouteNotifications()
Unreliable notifications are desired.
|
void |
useFederatedMapView()
Federates the view for methods in this session.
|
void |
useIsolatedMapView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getMapId()
Map
Id
associated with this
session. Map Id
associated with this sessionmandatory
- This method must be implemented. Map getMap() throws OperationFailedException, PermissionDeniedException
Map
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canRegisterForRouteNotifications()
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. false
if notification methods are not
authorized, true
otherwisemandatory
- This method must be implemented. void useFederatedMapView()
mandatory
- This method is must be implemented. void useIsolatedMapView()
mandatory
- This method is must be implemented. void reliableRouteNotifications()
acknowledgeRouteNotification()
.mandatory
- This method is must be implemented. void unreliableRouteNotifications()
mandatory
- This method is must be implemented. void acknowledgeRouteNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewRoutes() throws OperationFailedException, PermissionDeniedException
RouteReceiver.newRoutes()
is invoked when a new Route
appears in this map.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewRoutesForStartingLocation(Id startingLocationId) throws OperationFailedException, PermissionDeniedException
RouteReceiver.newRoutes()
is invoked when a
new Route
appears in this map.startingLocationId
- the Id
of the
Location
to monitorNullArgumentException
- startingLocationId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewRoutesForEndingLocation(Id endingLocationId) throws OperationFailedException, PermissionDeniedException
RouteReceiver.newRoutes()
is invoked when a
new Route
appears in this map.endingLocationId
- the Id
of the Location
to monitorNullArgumentException
- endingLocationId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewRoutesThroughLocation(Id locationId) throws OperationFailedException, PermissionDeniedException
RouteReceiver.newRoutes()
is invoked when a new
Route
appears in this map.locationId
- the Id
of the Location
to monitorNullArgumentException
- locationId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedRoutes() throws OperationFailedException, PermissionDeniedException
RouteReceiver.changedRoutes()
is invoked when a route in this
map is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedRoutesForStartingLocation(Id startingLocationId) throws OperationFailedException, PermissionDeniedException
RouteReceiver.updatedRoutes()
is invoked when
a route is changed in this map.startingLocationId
- the Id
of the
Location
to monitorNullArgumentException
- startingLocationId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedRoutesForEndingLocation(Id endingLocationId) throws OperationFailedException, PermissionDeniedException
RouteReceiver.changedRoutes()
is invoked when
a route is changed in this map.endingLocationId
- the Id
of the Location
to monitorNullArgumentException
- endingLocationId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedRoutesThroughLocation(Id locationId) throws OperationFailedException, PermissionDeniedException
RouteReceiver.changedRoutes()
is invoked when
a route is changed in this map.locationId
- the Id
of the Location
to monitorNullArgumentException
- locationId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedRoute(Id routeId) throws OperationFailedException, PermissionDeniedException
RouteReceiver.changedRoutes()
is invoked when the specified
route in this map is changed.routeId
- the Id
of the Route
to
monitorNullArgumentException
- routeId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedRoutes() throws OperationFailedException, PermissionDeniedException
RouteReceiver.deletedRoutes()
is invoked when a route is
deleted or removed from this map.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedRoutesForStartingLocation(Id startingLocationId) throws OperationFailedException, PermissionDeniedException
RouteReceiver.deletedRoutes()
is invoked when
a route is removed from this map.startingLocationId
- the Id
of the
Location
to monitorNullArgumentException
- startingLocationId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedRoutesForEndingLocation(Id endingLocationId) throws OperationFailedException, PermissionDeniedException
RouteReceiver.deletedRoutes()
is invoked when
a route is removed from this map.endingLocationId
- the Id
of the Location
to monitorNullArgumentException
- endingLocationId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedRoutesThroughLocation(Id locationId) throws OperationFailedException, PermissionDeniedException
RouteReceiver.deletedRoutes()
is invoked when
a route is removed from this map.locationId
- the Id
of the Location
to monitorNullArgumentException
- locationId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedRoute(Id routeId) throws OperationFailedException, PermissionDeniedException
RouteReceiver.deletedRoutes()
is invoked when the specified
route is deleted or removed from this map.routeId
- the Id
of the Route
to
monitorNullArgumentException
- routeId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.