org.osid.mapping.path

Interface PathNotificationSession

All Superinterfaces:

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

public interface PathNotificationSession
extends OsidSession

This session defines methods to receive notifications on adds/changes to Path objects in this Map. This also includes existing paths 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 PathLookupSession.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canRegisterForPathNotifications() Tests if this user can register for Path notifications.
Map	getMap() Gets the Map associated with this session.
Id	getMapId() Gets the Map Id associated with this session.
void	registerForChangedPath(Id pathId) Registers for notification of an updated path.
void	registerForChangedPaths() Registers for notification of updated paths.
void	registerForChangedPathsThroughLocation(Id locationId) Register for notifications of updated paths through the given location.
void	registerForDeletedPath(Id pathId) Registers for notification of a deleted path.
void	registerForDeletedPaths() Registers for notification of deleted paths.
void	registerForDeletedPathsThroughLocation(Id locationId) Register for notifications of deleted paths through the given location.
void	registerForNewPaths() Register for notifications of new paths.
void	registerForNewPathsThroughLocation(Id locationId) Register for notifications of new paths through the given location.
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.

canRegisterForPathNotifications

boolean canRegisterForPathNotifications()

Tests if this user can register for Path 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.

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 paths 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.

registerForNewPaths

void registerForNewPaths()
                         throws OperationFailedException,
                                PermissionDeniedException

Register for notifications of new paths. PathReceiver.newPaths() is invoked when a new Path appears in this map.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewPathsThroughLocation

void registerForNewPathsThroughLocation(Id locationId)
                                        throws OperationFailedException,
                                               PermissionDeniedException

Register for notifications of new paths through the given location. PathReceiver.newPaths() is invoked when a new Path appears in this map.

Parameters:

locationId - the Id of the Location to monitor

Throws:

NullArgumentException - locationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedPaths

void registerForChangedPaths()
                             throws OperationFailedException,
                                    PermissionDeniedException

Registers for notification of updated paths. PathReceiver.changedPaths() is invoked when a path in this map is changed.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedPathsThroughLocation

void registerForChangedPathsThroughLocation(Id locationId)
                                            throws OperationFailedException,
                                                   PermissionDeniedException

Register for notifications of updated paths through the given location. PathReceiver.changedPaths() is invoked when a path is changed in this map.

Parameters:

locationId - the Id of the Location to monitor

Throws:

NullArgumentException - locationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedPath

void registerForChangedPath(Id pathId)
                            throws OperationFailedException,
                                   PermissionDeniedException

Registers for notification of an updated path. PathReceiver.changedPaths() is invoked when the specified path in this map is changed.

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.

registerForDeletedPaths

void registerForDeletedPaths()
                             throws OperationFailedException,
                                    PermissionDeniedException

Registers for notification of deleted paths. PathReceiver.deletedPaths() is invoked when a path is deleted or removed from this map.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedPathsThroughLocation

void registerForDeletedPathsThroughLocation(Id locationId)
                                            throws OperationFailedException,
                                                   PermissionDeniedException

Register for notifications of deleted paths through the given location. PathReceiver.deletedPaths() is invoked when a path is removed from this map.

Parameters:

locationId - the Id of the Location to monitor

Throws:

NullArgumentException - locationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedPath

void registerForDeletedPath(Id pathId)
                            throws OperationFailedException,
                                   PermissionDeniedException

Registers for notification of a deleted path. PathReceiver.deletedPaths() is invoked when the specified path is deleted or removed from this map.

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.