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 |
---|---|
void |
acknowledgeMapNotification(Id notificationId)
Acknowledge a map notification.
|
boolean |
canRegisterForMapNotifications()
Tests if this user can register for
Map notifications. |
void |
registerForChangedMap(Id mapId)
Registers for notification of an updated map.
|
void |
registerForChangedMapHierarchy()
Registers for notification of an updated map hierarchy structure.
|
void |
registerForChangedMapHierarchyForAncestors(Id mapId)
Registers for notification of an updated map hierarchy structure.
|
void |
registerForChangedMapHierarchyForDescendants(Id mapId)
Registers for notification of an updated map hierarchy structure.
|
void |
registerForChangedMaps()
Registers for notification of updated maps.
|
void |
registerForDeletedMap(Id mapId)
Registers for notification of a deleted map.
|
void |
registerForDeletedMaps()
Registers for notification of deleted maps.
|
void |
registerForNewMaps()
Register for notifications of new maps.
|
void |
reliableMapNotifications()
Reliable notifications are desired.
|
void |
unreliableMapNotifications()
Unreliable notifications are desired.
|
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 reliableMapNotifications()
acknowledgeMapNotification()
.mandatory
- This method is must be implemented. void unreliableMapNotifications()
mandatory
- This method is must be implemented. void acknowledgeMapNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewMaps() throws OperationFailedException, PermissionDeniedException
MapReceiver.newMaps()
is invoked when a new Map
is created.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedMaps() throws OperationFailedException, PermissionDeniedException
MapReceiver.changedMaps()
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.changedMaps()
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.deletedMaps()
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.deletedMaps()
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 registerForChangedMapHierarchy() throws OperationFailedException, PermissionDeniedException
MapReceiver.changedChildOfMaps()
is invoked when a node
experiences a change in its children.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedMapHierarchyForAncestors(Id mapId) throws OperationFailedException, PermissionDeniedException
MapReceiver.changedChildOfMaps()
is invoked when the
specified node or any of its ancestors experiences a change in its
children.mapId
- the Id
of the Map
node to
monitorNullArgumentException
- mapId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedMapHierarchyForDescendants(Id mapId) throws OperationFailedException, PermissionDeniedException
MapReceiver.changedChildOfMaps()
is invoked when the
specified node or any of its descendants experiences a change in its
children.mapId
- the Id
of the Map
node to
monitorNullArgumentException
- mapId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.