org.osid.mapping.path

Interface IntersectionNotificationSession

All Superinterfaces:

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

public interface IntersectionNotificationSession
extends OsidSession

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canRegisterForIntersectionNotifications() Tests if this user can register for Intersection notifications.
Map	getMap() Gets the Map associated with this session.
Id	getMapId() Gets the Map Id associated with this session.
void	registerForChangedIntersection(Id intersectionId) Registers for notification of an updated intersection.
void	registerForChangedIntersections() Registers for notification of updated intersections.
void	registerForChangedIntersectionsForPath(Id pathId) Register for notifications of updated intersections for the given path.
void	registerForDeletedIntersection(Id intersectionId) Registers for notification of a deleted intersection.
void	registerForDeletedIntersections() Registers for notification of deleted intersections.
void	registerForDeletedIntersectionsForPath(Id pathId) Register for notifications of deleted intersections for the given path.
void	registerForNewIntersections() Register for notifications of new intersections.
void	registerForNewIntersectionsForPath(Id pathId) Register for notifications of new intersections for the given path.
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.

canRegisterForIntersectionNotifications

boolean canRegisterForIntersectionNotifications()

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

registerForNewIntersections

void registerForNewIntersections()
                                 throws OperationFailedException,
                                        PermissionDeniedException

Register for notifications of new intersections. IntersectionReceiver.newIntersections() is invoked when a new Intersection appears in this map.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewIntersectionsForPath

void registerForNewIntersectionsForPath(Id pathId)
                                        throws OperationFailedException,
                                               PermissionDeniedException

Register for notifications of new intersections for the given path. IntersectionReceiver.newIntersections() is invoked when a new Intersection appears in 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.

registerForChangedIntersections

void registerForChangedIntersections()
                                     throws OperationFailedException,
                                            PermissionDeniedException

Registers for notification of updated intersections. IntersectionReceiver.changedIntersections() is invoked when an intersection in this map is changed.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedIntersectionsForPath

void registerForChangedIntersectionsForPath(Id pathId)
                                            throws OperationFailedException,
                                                   PermissionDeniedException

Register for notifications of updated intersections for the given path. IntersectionReceiver.changedIntersections() is invoked when an intersection is changed in 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.

registerForChangedIntersection

void registerForChangedIntersection(Id intersectionId)
                                    throws OperationFailedException,
                                           PermissionDeniedException

Registers for notification of an updated intersection. IntersectionReceiver.changedIntersections() is invoked when the specified intersection in this map is changed.

Parameters:

intersectionId - the Id of the Intersection to monitor

Throws:

NullArgumentException - intersectionId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedIntersections

void registerForDeletedIntersections()
                                     throws OperationFailedException,
                                            PermissionDeniedException

Registers for notification of deleted intersections. IntersectionReceiver.deletedIntersection() is invoked when an intersection is deleted or removed from this map.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedIntersectionsForPath

void registerForDeletedIntersectionsForPath(Id pathId)
                                            throws OperationFailedException,
                                                   PermissionDeniedException

Register for notifications of deleted intersections for the given path. IntersectionReceiver.deletedIntersections() is invoked when an intersection is 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.

registerForDeletedIntersection

void registerForDeletedIntersection(Id intersectionId)
                                    throws OperationFailedException,
                                           PermissionDeniedException

Registers for notification of a deleted intersection. IntersectionReceiver.deletedIntersections() is invoked when the specified intersection is deleted or removed from this map.

Parameters:

intersectionId - the Id of the Intersection to monitor

Throws:

NullArgumentException - intersectionId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.