public interface MapNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to Map
objects. 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 |
---|---|
boolean |
canRegisterForMapNotifications()
Tests if this user can register for
Map notifications. |
void |
registerForChangedMap(Id mapId)
Registers for notification of an updated map.
|
void |
registerForChangedMaps()
Registers for notification of updated maps.
|
void |
registerForDeletedMap(Id mapId)
Registers for notification of a deleted map.
|
void |
registerForDeletedMapAncestors(Id mapId)
Registers for notification if an ancestor is removed from the
specified map in the map hierarchy.
|
void |
registerForDeletedMapDescendants(Id mapId)
Registers for notification if a descendant is removed from fthe
specified map in the map hierarchy.
|
void |
registerForDeletedMaps()
Registers for notification of deleted maps.
|
void |
registerForNewMapAncestors(Id mapId)
Registers for notification if an ancestor is added to the specified
map in the map hierarchy.
|
void |
registerForNewMapDescendants(Id mapId)
Registers for notification if a descendant is added to the specified
map in the map hierarchy.
|
void |
registerForNewMaps()
Register for notifications of new maps.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canRegisterForMapNotifications()
Map
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 registerForNewMaps() throws OperationFailedException, PermissionDeniedException
MapReceiver.newMap()
is invoked when a new Map
is created.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewMapAncestors(Id mapId) throws OperationFailedException, PermissionDeniedException
MapReceiver.newMapAncestor()
is invoked when the specified map experiences an addition in ancestry.mapId
- the Id
of the map to monitorNullArgumentException
- mapId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewMapDescendants(Id mapId) throws OperationFailedException, PermissionDeniedException
MapReceiver.newMapDescendant()
is invoked when the specified map experiences an addition in
descendants.mapId
- the Id
of the map to monitorNullArgumentException
- mapId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedMaps() throws OperationFailedException, PermissionDeniedException
MapReceiver.changedMap()
is invoked when a map is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedMap(Id mapId) throws OperationFailedException, PermissionDeniedException
MapReceiver.changedMap()
is invoked when the specified map is
changed.mapId
- the Id of the Map
to monitorNullArgumentException
- E
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedMaps() throws OperationFailedException, PermissionDeniedException
MapReceiver.deletedMap()
is invoked when a map is deleted.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedMap(Id mapId) throws OperationFailedException, PermissionDeniedException
MapReceiver.deletedMap()
is invoked when the specified map is
deleted.mapId
- the Id
of the Map
to
monitorNullArgumentException
- mapId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedMapAncestors(Id mapId) throws OperationFailedException, PermissionDeniedException
MapReceiver.deletedMapAncestor()
is invoked when the specified
map experiences a removal of an ancestor.mapId
- the Id
of the map to monitorNullArgumentException
- mapId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedMapDescendants(Id mapId) throws OperationFailedException, PermissionDeniedException
MapReceiver.deletedMapDescednant()
is invoked when the
specified map experiences a removal of one of its descdendents.mapId
- the Id
of the map to monitorNullArgumentException
- mapId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.