org.osid.mapping.path

Interface ResourceSignalNotificationSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

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.

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getMapId

Id getMapId()

Gets the Map Id associated with this session.

Returns:

the Map Id associated with this session

Compliance:

mandatory - This method must be implemented.

getMap

Map getMap()
           throws OperationFailedException,
                  PermissionDeniedException

Gets the Map associated with this session.

Returns:

the map

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canRegisterForResourceSignalNotifications

boolean canRegisterForResourceSignalNotifications()

Tests if this user can register for 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 wish not to offer notification operations to unauthorized users.

Returns:

false if notification methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useFederatedMapView

void useFederatedMapView()

Federates the view for methods in this session. A federated view will include signals in maps which are children of this map in the map hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedMapView

void useIsolatedMapView()

Isolates the view for methods in this session. An isolated view restricts notifications to this map only.

Compliance:

mandatory - This method is must be implemented.

registerForSignals

void registerForSignals()
                        throws OperationFailedException,
                               PermissionDeniedException

Register for notifications of resources passing signals. ResourceSignalReceiver.crossedSignal() is invoked when a resource crosses a signal.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForCrossedSignal

void registerForCrossedSignal(Id signalId)
                              throws OperationFailedException,
                                     PermissionDeniedException

Register for notifications of resources crossing a given signal. ResourceSignalReceiver.crossedSignal() is invoked when a resource crosses the designated signal.

Parameters:

signalId - the Id of the Signal to monitor

Throws:

NullArgumentException - signalId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForCrossedSignalsForResource

void registerForCrossedSignalsForResource(Id resourceId)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Register for notifications of resources crossing signals. ResourcePathReceiver.crossedSignal() is invoked when the specified resource crosses a signal.

Parameters:

resourceId - the Id of the Resource to monitor

Throws:

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForCrossedSignalsForResourcesByGenusType

void registerForCrossedSignalsForResourcesByGenusType(Type resourceGenusType)
                                                      throws OperationFailedException,
                                                             PermissionDeniedException

Register for notifications of resources crossing signals for resources of the given genus type. ResourcePathReceiver.crossedSignal() is invoked when the specified resource crosses a signal.

Parameters:

resourceGenusType - the genus type of the Resource to monitor

Throws:

NullArgumentException - resourceGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForCrossedSignalsByPath

void registerForCrossedSignalsByPath(Id pathId)
                                     throws OperationFailedException,
                                            PermissionDeniedException

Register for notifications of resources crossing signals on the given path. ResourcePathReceiver.crossedSignal() is invoked when the specified resource crosses a signal.

Parameters:

pathId - the Id of the Path to monitor

Throws:

NullArgumentException - pathId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.