public interface ResourceRouteNotificationSession extends OsidSession
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.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeResourceRouteNotification(Id notificationId)
Acknowledge a resource route notification.
|
boolean |
canRegisterForResourceRouteNotifications()
Tests if this user can register for notifications.
|
Map |
getMap()
Gets the
Map associated with this session. |
Id |
getMapId()
Gets the
Map Id associated with this
session. |
void |
registerForCancelledRoute(Id routeId)
Register for notifications of a cancelled route.
|
void |
registerForCancelledRoutes()
Registers for notification of cancelled routes.
|
void |
registerForCancelledRoutesByEndingLocation(Id locationId)
Registers for notification of cancelled routes from the specified
ending location.
|
void |
registerForCancelledRoutesByStartingLocation(Id locationId)
Registers for notification of cancelled routes from the specified
starting location.
|
void |
registerForCancelledRoutesForResource(Id resourceId)
Registers for notification of cancelled routes for the given resource.
|
void |
registerForCancelledRoutesForResourcesByGenusType(Type resourceGenusType)
Registers for notification of cancelled routes for resources of the
given resource genus type.
|
void |
registerForCompletedRoute(Id routeId)
Register for notifications of a completed route.
|
void |
registerForCompletedRoutes()
Registers for notification of completed routes.
|
void |
registerForCompletedRoutesByEndingLocation(Id locationId)
Registers for notification of a completed route from the specified
ending location.
|
void |
registerForCompletedRoutesByStartingLocation(Id locationId)
Registers for notification of a completed route from the specified
starting location.
|
void |
registerForCompletedRoutesForResource(Id resourceId)
Registers for notification of a completed route for the given
resource.
|
void |
registerForCompletedRoutesForResourcesByGenusType(Type resourceGenusType)
Registers for notification of a completed route for resources of the
given resource genus type.
|
void |
registerForNewRouteSegment(Id routeSegmentId)
Registers for notification of new route segments.
|
void |
registerForNewRouteSegments()
Registers for notification of new route segments.
|
void |
registerForNewRouteSegmentsForResource(Id resourceId)
Registers for notification of new route segments for the given
resource.
|
void |
registerForNewRouteSegmentsForResourcesByGenusType(Type resourceGenusType)
Registers for notification of new route segments for resources of the
given genus type.
|
void |
registerForStartedRoute(Id routeId)
Register for notifications of a started route.
|
void |
registerForStartedRoutes()
Register for notifications of new routes for a resource.
|
void |
registerForStartedRoutesByEndingLocation(Id locationId)
Register for notifications of a started route to the specified
location.
|
void |
registerForStartedRoutesByStartingLocation(Id locationId)
Register for notifications of a started route from the specified
location.
|
void |
registerForStartedRoutesForResource(Id resourceId)
Register for notifications of a started route for the given resource.
|
void |
registerForStartedRoutesForResourcesByGenusType(Type resourceGenusType)
Register for notifications of a started route for resources of the
given resource genus type.
|
void |
reliableResourceRouteNotifications()
Reliable notifications are desired.
|
void |
unreliableResourceRouteNotifications()
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 canRegisterForResourceRouteNotifications()
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 reliableResourceRouteNotifications()
acknowledgeResourceRouteNotification()
.mandatory
- This method is must be implemented. void unreliableResourceRouteNotifications()
mandatory
- This method is must be implemented. void acknowledgeResourceRouteNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForStartedRoutes() throws OperationFailedException, PermissionDeniedException
ResourceRouteReceiver.startedRoute()
is invoked when a
resource begins a route.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForStartedRoute(Id routeId) throws OperationFailedException, PermissionDeniedException
ResourceRouteReceiver.startedRoute()
is invoked when a
resource begins the specified route.routeId
- the Id
of the Route
to
monitorNullArgumentException
- routeId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForStartedRoutesByStartingLocation(Id locationId) throws OperationFailedException, PermissionDeniedException
ResourceRouteReceiver.startedRoute()
is
invoked when the specified resource begins a route.locationId
- the Id
of the Location
to monitorNullArgumentException
- locationId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForStartedRoutesByEndingLocation(Id locationId) throws OperationFailedException, PermissionDeniedException
ResourceRouteReceiver.startedRoute()
is
invoked when the specified resource begins a route.locationId
- the Id
of the Location
to monitorNullArgumentException
- locationId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForStartedRoutesForResource(Id resourceId) throws OperationFailedException, PermissionDeniedException
ResourceRouteReceiver.startedRoute()
is invoked when
the specified resource begins a route.resourceId
- the Id
of the Resource
to monitorNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForStartedRoutesForResourcesByGenusType(Type resourceGenusType) throws OperationFailedException, PermissionDeniedException
ResourceRouteReceiver.startedRoute()
is invoked when the specified resource begins a route.resourceGenusType
- the genus type of the Resource
to monitorNullArgumentException
- resourceGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForCompletedRoutes() throws OperationFailedException, PermissionDeniedException
ResourceRouteReceiver.completedRoute()
is invoked when a
resource completes a route.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForCompletedRoute(Id routeId) throws OperationFailedException, PermissionDeniedException
ResourceRouteReceiver.completedRoute()
is invoked when a
resource completes the specified route.routeId
- the Id
of the Route
to
monitorNullArgumentException
- routeId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForCompletedRoutesByStartingLocation(Id locationId) throws OperationFailedException, PermissionDeniedException
ResourceRouteReceiver.completedRoute()
is invoked when the specified resource completes a route.locationId
- the Id
of the Location
to monitorNullArgumentException
- locationId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForCompletedRoutesByEndingLocation(Id locationId) throws OperationFailedException, PermissionDeniedException
ResourceRouteReceiver.completedRoute()
is invoked when the specified resource completes a route.locationId
- the Id
of the Location
to monitorNullArgumentException
- locationId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForCompletedRoutesForResource(Id resourceId) throws OperationFailedException, PermissionDeniedException
ResourceRouteReceiver.completedRoute()
is
invoked when the specified resource completes a route.resourceId
- the Id
of the Resource
to monitorNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForCompletedRoutesForResourcesByGenusType(Type resourceGenusType) throws OperationFailedException, PermissionDeniedException
ResourceRouteReceiver.completedRoute()
is invoked when the
specified resource completes a route.resourceGenusType
- the genus type of the Resource
to monitorNullArgumentException
- resourceGenusTYpe
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForCancelledRoutes() throws OperationFailedException, PermissionDeniedException
ResourceRouteReceiver.cancelledRoute()
is invoked when a
resource cancels a route.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForCancelledRoute(Id routeId) throws OperationFailedException, PermissionDeniedException
ResourceRouteReceiver.completedRoute()
is invoked when a
resource cancels the specified route.routeId
- the Id
of the Route
to
monitorNullArgumentException
- routeId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForCancelledRoutesByStartingLocation(Id locationId) throws OperationFailedException, PermissionDeniedException
ResourceRouteReceiver.cancelledRoute()
is invoked when a specified resource cancels a route.locationId
- the Id
of the Location
to monitorNullArgumentException
- locationId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForCancelledRoutesByEndingLocation(Id locationId) throws OperationFailedException, PermissionDeniedException
ResourceRouteReceiver.cancelledRoute()
is invoked when a specified resource cancels a route.locationId
- the Id
of the Location
to monitorNullArgumentException
- locationId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForCancelledRoutesForResource(Id resourceId) throws OperationFailedException, PermissionDeniedException
ResourceRouteReceiver.cancelledRoute()
is invoked when
a specified resource cancels a route.resourceId
- the Id
of the Resource
to monitorNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForCancelledRoutesForResourcesByGenusType(Type resourceGenusType) throws OperationFailedException, PermissionDeniedException
ResourceRouteReceiver.cancelledRoute()
is invoked when a
specified resource cancels a route.resourceGenusType
- the genus type of the Resource
to monitorNullArgumentException
- resourceGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewRouteSegments() throws OperationFailedException, PermissionDeniedException
ResourceRouteReceiver.newRouteSegment()
is invoked when a
resource moves on to a new route segment.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewRouteSegment(Id routeSegmentId) throws OperationFailedException, PermissionDeniedException
ResourceRouteReceiver.newRouteSegment()
is invoked when a
resource moves on to the desigtnated route segment.routeSegmentId
- the Id
of the
RouteSegment
to monitorNullArgumentException
- routeSegmentId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewRouteSegmentsForResource(Id resourceId) throws OperationFailedException, PermissionDeniedException
ResourceRouteReceiver.newRouteSegment()
is
invoked when the specified resource moves on to a new route segment.resourceId
- the Id
of the Resource
to monitorNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewRouteSegmentsForResourcesByGenusType(Type resourceGenusType) throws OperationFailedException, PermissionDeniedException
ResourceRouteReceiver.newRouteSegment()
is invoked when the specified resource moves on to a new route
segment.resourceGenusType
- the genus type of the Resource
to monitorNullArgumentException
- resourceGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.