public interface PathNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to Path
objects in this Map.
This also
includes existing paths 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
PathLookupSession.
Modifier and Type | Method and Description |
---|---|
boolean |
canRegisterForPathNotifications()
Tests if this user can register for
Path notifications. |
Map |
getMap()
Gets the
Map associated with this session. |
Id |
getMapId()
Gets the
Map Id associated with this
session. |
void |
registerForChangedPath(Id pathId)
Registers for notification of an updated path.
|
void |
registerForChangedPaths()
Registers for notification of updated paths.
|
void |
registerForChangedPathsThroughLocation(Id locationId)
Register for notifications of updated paths through the given
location.
|
void |
registerForDeletedPath(Id pathId)
Registers for notification of a deleted path.
|
void |
registerForDeletedPaths()
Registers for notification of deleted paths.
|
void |
registerForDeletedPathsThroughLocation(Id locationId)
Register for notifications of deleted paths through the given
location.
|
void |
registerForNewPaths()
Register for notifications of new paths.
|
void |
registerForNewPathsThroughLocation(Id locationId)
Register for notifications of new paths through the given location.
|
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 canRegisterForPathNotifications()
Path
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 registerForNewPaths() throws OperationFailedException, PermissionDeniedException
PathReceiver.newPaths()
is invoked when a new Path
appears in this map.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewPathsThroughLocation(Id locationId) throws OperationFailedException, PermissionDeniedException
PathReceiver.newPaths()
is invoked when a new
Path
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 registerForChangedPaths() throws OperationFailedException, PermissionDeniedException
PathReceiver.changedPaths()
is invoked when a path in this map
is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedPathsThroughLocation(Id locationId) throws OperationFailedException, PermissionDeniedException
PathReceiver.changedPaths()
is invoked when a
path 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 registerForChangedPath(Id pathId) throws OperationFailedException, PermissionDeniedException
PathReceiver.changedPaths()
is invoked when the specified path
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 registerForDeletedPaths() throws OperationFailedException, PermissionDeniedException
PathReceiver.deletedPaths()
is invoked when a path is deleted
or removed from this map.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedPathsThroughLocation(Id locationId) throws OperationFailedException, PermissionDeniedException
PathReceiver.deletedPaths()
is invoked when a
path 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 registerForDeletedPath(Id pathId) throws OperationFailedException, PermissionDeniedException
PathReceiver.deletedPaths()
is invoked when the specified path
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.