public interface SpeedZoneNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to SpeedZone
objects in this Map.
This also
includes existing speed zones that may appear or disappear due to changes
in the SpeedZone
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
SpeedZoneLookupSession.
Modifier and Type | Method and Description |
---|---|
boolean |
canRegisterForSpeedZoneNotifications()
Tests if this user can register for
SpeedZone
notifications. |
Map |
getMap()
Gets the
Map associated with this session. |
Id |
getMapId()
Gets the
Map Id associated with this
session. |
void |
registerForChangedSpeedZone(Id speedZoneId)
Registers for notification of an updated speed zone.
|
void |
registerForChangedSpeedZones()
Registers for notification of updated speed zones.
|
void |
registerForChangedSpeedZonesForPath(Id pathId)
Register for notifications of updated speed zones on the given path.
|
void |
registerForDeletedSpeedZone(Id speedZoneId)
Registers for notification of a deleted speed zone.
|
void |
registerForDeletedSpeedZones()
Registers for notification of deleted speed zones.
|
void |
registerForDeletedSpeedZonesForPath(Id pathId)
Register for notifications of deleted speed zones on the given path.
|
void |
registerForNewSpeedZones()
Register for notifications of new speed zones.
|
void |
registerForNewSpeedZonesForPath(Id pathId)
Register for notifications of new speed zones on the given path.
|
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 canRegisterForSpeedZoneNotifications()
SpeedZone
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 registerForNewSpeedZones() throws OperationFailedException, PermissionDeniedException
SpeedZoneReceiver.newSpeedZones()
is invoked when a new
SpeedZone
appears in this map.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewSpeedZonesForPath(Id pathId) throws OperationFailedException, PermissionDeniedException
SpeedZoneReceiver.newSpeedZones()
is invoked when a new
SpeedZone
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 registerForChangedSpeedZones() throws OperationFailedException, PermissionDeniedException
SpeedZoneReceiver.changedSpeedZones()
is invoked when a speed
zone in this map is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedSpeedZonesForPath(Id pathId) throws OperationFailedException, PermissionDeniedException
SpeedZoneReceiver.changedSpeedZones()
is invoked when a
SpeedZone
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 registerForChangedSpeedZone(Id speedZoneId) throws OperationFailedException, PermissionDeniedException
SpeedZoneReceiver.changedSpeedZones()
is invoked when the
specified speed zone in this map is changed.speedZoneId
- the Id
of the SpeedZone
to monitorNullArgumentException
- speedZoneId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedSpeedZones() throws OperationFailedException, PermissionDeniedException
SpeedZoneReceiver.deletedSpeedZones()
is invoked when a speed
zone is deleted or removed from this map.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedSpeedZonesForPath(Id pathId) throws OperationFailedException, PermissionDeniedException
SpeedZoneReceiver.changedSpeedZone()
is invoked when a
SpeedZone
is removed or deleted 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. void registerForDeletedSpeedZone(Id speedZoneId) throws OperationFailedException, PermissionDeniedException
SpeedZoneReceiver.deletedSpeedZones()
is invoked when the
specified speed zone is deleted or removed from this map.speedZoneId
- the Id
of the SpeedZone
to monitorNullArgumentException
- speedZoneId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.