public interface ResourcePathNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to resources on paths 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 |
registerForEnteredPath(Id pathId)
Register for notifications of resources starting on paths.
|
void |
registerForEnteredPaths()
Register for notifications of resource starting on paths.
|
void |
registerForEnteredPathsForResource(Id resourceId)
Register for notifications of a started path.
|
void |
registerForEnteredPathsForResourcesByGenusType(Type resourceGenusType)
Register for notifications of a started path for resources of the
given genus type.
|
void |
registerForExitedPath(Id pathId)
Register for notifications of resources exits paths.
|
void |
registerForExitedPaths()
Register for notifications of resource exits paths.
|
void |
registerForExitedPathsForResource(Id resourceId)
Register for notifications of an exited path.
|
void |
registerForExitedPathsForResourcesByGenusType(Type resourceGenusType)
Register for notifications of an exited path for resources of the
given 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 registerForEnteredPaths() throws OperationFailedException, PermissionDeniedException
ResourcePathReceiver.enteredPath()
is invoked when a resource
turns on to a path.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForEnteredPath(Id pathId) throws OperationFailedException, PermissionDeniedException
ResourcePathReceiver.enteredPath()
is invoked when a resource
turns on to the specified path.pathId
- the Id
of the Path
to
monitorNullArgumentException
- pathId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForEnteredPathsForResource(Id resourceId) throws OperationFailedException, PermissionDeniedException
ResourcePathReceiver.enteredPath()
is invoked when the
specified resource begins a path.resourceId
- the Id
of the Resource
to monitorNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForEnteredPathsForResourcesByGenusType(Type resourceGenusType) throws OperationFailedException, PermissionDeniedException
ResourcePathReceiver.enteredPath()
is
invoked when the specified resource begins a path.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 registerForExitedPaths() throws OperationFailedException, PermissionDeniedException
ResourcePathReceiver.exitedPath()
is invoked when a resource
turns leaves a path.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForExitedPath(Id pathId) throws OperationFailedException, PermissionDeniedException
ResourcePathReceiver.exitedPath()
is invoked when a resource
leaves the specified path.pathId
- the Id
of the Path
to
monitorNullArgumentException
- pathId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForExitedPathsForResource(Id resourceId) throws OperationFailedException, PermissionDeniedException
ResourcePathReceiver.exitedPath()
is invoked when the
specified resource leaves a path.resourceId
- the Id
of the Resource
to monitorNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForExitedPathsForResourcesByGenusType(Type resourceGenusType) throws OperationFailedException, PermissionDeniedException
ResourcePathReceiver.exitedPath()
is
invoked when the specified resource leaves a path.resourceGenusType
- the genus type of the Resource
to monitorNullArgumentException
- resourceGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.