public interface SignalEnablerNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to SignalEnabler
objects in this Map.
This
also includes existing SignalEnablers
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
SignalEnablerLookupSession.
Modifier and Type | Method and Description |
---|---|
boolean |
canRegisterForSignalEnablerNotifications()
Tests if this user can register for
SignalEnabler
notifications. |
Map |
getMap()
Gets the
Map associated with this session. |
Id |
getMapId()
Gets the
Map Id associated with this
session. |
void |
registerForChangedSignalEnabler(Id signalEnablerId)
Registers for notification of an updated signal enabler.
|
void |
registerForChangedSignalEnablers()
Registers for notification of updated map.
|
void |
registerForDeletedSignalEnabler(Id signalEnablerId)
Registers for notification of a deleted signal enabler.
|
void |
registerForDeletedSignalEnablers()
Registers for notification of deleted signal enablers.
|
void |
registerForNewSignalEnablers()
Register for notifications of new signal enablers.
|
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 canRegisterForSignalEnablerNotifications()
SignalEnabler
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 registerForNewSignalEnablers() throws OperationFailedException, PermissionDeniedException
SignalEnablerReceiver.newSignalEnablers()
is invoked when a
new SignalEnabler
appears in this map.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedSignalEnablers() throws OperationFailedException, PermissionDeniedException
SignalEnablerReceiver.changedSignalEnablers()
is invoked when
a signal enabler in this map is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedSignalEnabler(Id signalEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ProvisionableReceiver.changedSignalEnablers()
is invoked when
the specified signal enabler in this map is changed.signalEnablerId
- the Id
of the
SignalEnabler
to monitorNotFoundException
- a signal enabler was not found in
this broker matchmaker identified by the given Id
NullArgumentException
- signalEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedSignalEnablers() throws OperationFailedException, PermissionDeniedException
SignalEnablerReceiver.deletedSignalEnablers()
is invoked when
a signal enabler is deleted or removed from this map.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedSignalEnabler(Id signalEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
SignalEnablerReceiver.deletedSignalEnablers()
is invoked when
the specified signal enabler is deleted or removed from this map.signalEnablerId
- the Id
of the
SignalEnabler
to monitorNotFoundException
- a signal enabler was not found in
this broker matchmaker identified by the given Id
NullArgumentException
- signalEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.