public interface ResourceSignalNotificationSession extends OsidSession
This session defines methods to receive notifications for signal
crossings in this Map.
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 |
canRegisterForResourceSignalNotifications()
Tests if this user can register for notifications.
|
Map |
getMap()
Gets the
Map associated with this session. |
Id |
getMapId()
Gets the
Map Id associated with this
session. |
void |
registerForCrossedSignal(Id signalId)
Register for notifications of resources crossing a given signal.
|
void |
registerForCrossedSignalsByPath(Id pathId)
Register for notifications of resources crossing signals on the given
path.
|
void |
registerForCrossedSignalsForResource(Id resourceId)
Register for notifications of resources crossing signals.
|
void |
registerForCrossedSignalsForResourcesByGenusType(Type resourceGenusType)
Register for notifications of resources crossing signals for resources
of the given genus type.
|
void |
registerForSignals()
Register for notifications of resources passing signals.
|
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 canRegisterForResourceSignalNotifications()
PERMISSION_DENIED.
This is intended as a hint to an
application that may wish not to offer notification operations to
unauthorized users. 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 registerForSignals() throws OperationFailedException, PermissionDeniedException
ResourceSignalReceiver.crossedSignal()
is invoked when a
resource crosses a signal.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForCrossedSignal(Id signalId) throws OperationFailedException, PermissionDeniedException
ResourceSignalReceiver.crossedSignal()
is invoked when
a resource crosses the designated signal.signalId
- the Id
of the Signal
to
monitorNullArgumentException
- signalId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForCrossedSignalsForResource(Id resourceId) throws OperationFailedException, PermissionDeniedException
ResourcePathReceiver.crossedSignal()
is invoked when the
specified resource crosses a signal.resourceId
- the Id
of the Resource
to monitorNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForCrossedSignalsForResourcesByGenusType(Type resourceGenusType) throws OperationFailedException, PermissionDeniedException
ResourcePathReceiver.crossedSignal()
is invoked when the specified resource crosses a signal.resourceGenusType
- the genus type of the Resource
to monitorNullArgumentException
- resourceGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForCrossedSignalsByPath(Id pathId) throws OperationFailedException, PermissionDeniedException
ResourcePathReceiver.crossedSignal()
is invoked
when the specified resource crosses a signal.pathId
- the Id
of the Path
to
monitorNullArgumentException
- pathId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.