public interface ObstacleNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to Obstacle
objects in this Map.
This also
includes existing obstacle that may appear or disappear due to changes in
the Obstacle
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
ObstacleLookupSession.
Modifier and Type | Method and Description |
---|---|
boolean |
canRegisterForObstacleNotifications()
Tests if this user can register for
Obstacle
notifications. |
Map |
getMap()
Gets the
Map associated with this session. |
Id |
getMapId()
Gets the
Map Id associated with this
session. |
void |
registerForChangedObstacle(Id obstacleId)
Registers for notification of an updated obstacle.
|
void |
registerForChangedObstacles()
Registers for notification of updated obstacles.
|
void |
registerForChangedObstaclesForPath(Id pathId)
Registers for notification of updated obstacles along the given path.
|
void |
registerForDeletedObstacle(Id obstacleId)
Registers for notification of a deleted obstacle.
|
void |
registerForDeletedObstacles()
Registers for notification of deleted obstacles.
|
void |
registerForDeletedObstaclesForPath(Id pathId)
Registers for notification of deleted obstacleq for the given path.
|
void |
registerForNewObstacles()
Register for notifications of new obstacles.
|
void |
registerForNewObstaclesForPath(Id pathId)
Register for notifications of new obstacles.
|
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 canRegisterForObstacleNotifications()
Obstacle
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 registerForNewObstacles() throws OperationFailedException, PermissionDeniedException
ObstacleReceiver.newObstacles()
is invoked when a new
Obstacle
appears in this map.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewObstaclesForPath(Id pathId) throws OperationFailedException, PermissionDeniedException
ObstacleReceiver.newObstacles()
is invoked when a new
Obstacle
appears in this map.pathId
- the Id
of the path to monitorNullArgumentException
- pathId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedObstacles() throws OperationFailedException, PermissionDeniedException
ObstacleReceiver.changedObstacles()
is invoked when an
obstacle in this map is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedObstacle(Id obstacleId) throws OperationFailedException, PermissionDeniedException
ObstacleReceiver.changedObstacles()
is invoked when the
specified obstacle in this map is changed.obstacleId
- the Id
of the Obstacle
to monitorNullArgumentException
- obstacleId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedObstaclesForPath(Id pathId) throws OperationFailedException, PermissionDeniedException
ObstacleReceiver.changedObstacles()
is invoked when an
obstacle in this map is changed.pathId
- the Id
of the Path
to
monitorNullArgumentException
- pathId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedObstacles() throws OperationFailedException, PermissionDeniedException
ObstacleReceiver.deletedObstacles()
is invoked when an
obstacle is deleted or removed from this map.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedObstacle(Id obstacleId) throws OperationFailedException, PermissionDeniedException
ObstacleReceiver.deletedObstacles()
is invoked when the
specified obstacle is deleted or removed from this map.obstacleId
- the Id
of the Obstacle
to monitorNullArgumentException
- obstacleId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedObstaclesForPath(Id pathId) throws OperationFailedException, PermissionDeniedException
ObstacleReceiver.deletedObstacles()
is invoked when an
obstacle is deleted or removed from this map.pathId
- the Id
of the path to monitorNullArgumentException
- pathId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.