public interface ResourceVelocityNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to resource velocities 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 |
canRegisterForResourcePathNotifications()
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 |
registerFoChangedResourceVelocity(Id resourceId)
Registers for notification of moving resources.
|
void |
registerForChangedResourceVelocities()
Registers for notification of changed resource velocities.
|
void |
registerForChangedResourceVelocitiesByGenusType(Type resourceGenusType)
Registers for notification of moving resources for the given resource
genus type.
|
void |
registerForMovingResource(Id resourceId)
Registers for notification of moved resources.
|
void |
registerForMovingResources()
Registers for notification of moved resources.
|
void |
registerForMovingResourcesByGenusType(Type resourceGenusType)
Registers for notification of moved resources for the given resource
genus type.
|
void |
registerForStoppedResource(Id resourceId)
Registers for notification of stopped resources.
|
void |
registerForStoppedResources()
Registers for notification of stopped resources.
|
void |
registerForStoppedResourcesByGenusType(Type resourceGenusType)
Registers for notification of stopped resources for the given resource
genus type.
|
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 canRegisterForResourcePathNotifications()
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 registerForMovingResources() throws OperationFailedException, PermissionDeniedException
ResourceVelocityReceiver.movingResource()
is invoked when a
resource begins to move.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForMovingResource(Id resourceId) throws OperationFailedException, PermissionDeniedException
ResourceVelocityReceiver.movingResource()
is invoked when the
specified resource begins to move.resourceId
- the Id
of the Resource
to monitorNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForMovingResourcesByGenusType(Type resourceGenusType) throws OperationFailedException, PermissionDeniedException
ResourceVelocityReceiver.movingResource()
is invoked when a resource begins to move.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 registerForStoppedResources() throws OperationFailedException, PermissionDeniedException
ResourceVelocityReceiver.stoppedResource()
is invoked when a
resource stops moving.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForStoppedResource(Id resourceId) throws OperationFailedException, PermissionDeniedException
ResourceVelocityReceiver.stoppedResource()
is invoked when the
specified resource stops moving.resourceId
- the Id
of the Resource
to monitorNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForStoppedResourcesByGenusType(Type resourceGenusType) throws OperationFailedException, PermissionDeniedException
ResourceVelocityReceiver.stoppedResource()
is invoked when a resource stops moving.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 registerForChangedResourceVelocities() throws OperationFailedException, PermissionDeniedException
ResourceRouteReceiver.changedResourceVelcoity()
is invoked
when a resource changes speed or direction.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerFoChangedResourceVelocity(Id resourceId) throws OperationFailedException, PermissionDeniedException
ResourceRouteReceiver.changedResourceVelocityResource()
is
invoked when the specified resource changes speed or direction.resourceId
- the Id
of the Resource
to monitorNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedResourceVelocitiesByGenusType(Type resourceGenusType) throws OperationFailedException, PermissionDeniedException
ResourceRouteReceiver.changedResourceVelocity()
is invoked when a resource changes speed or direction.resourceGenusType
- the genus type of the Resource
to monitorNullArgumentException
- resourceGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.