OSID Logo
OSID Specifications
mapping path package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.path.ObstacleNotificationSession
Implementsosid.OsidSession
Description

This session defines methods to receive notifications on adds/changes to Obstacle objects in this Map. This also includes existing obstacle that may appear or disappear due to changes in the Obstacle 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 ObstacleLookupSession.

MethodgetMapId
Description

Gets the Map Id associated with this session.

Returnosid.id.Idthe Map Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetMap
Description

Gets the Map associated with this session.

Returnosid.mapping.Mapthe map
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanRegisterForObstacleNotifications
Description

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

Returnboolean false if notification methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseFederatedMapView
Description

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

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedMapView
Description

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

CompliancemandatoryThis method is must be implemented.
MethodregisterForNewObstacles
Description

Register for notifications of new obstacles. ObstacleReceiver.newObstacles() is invoked when a new Obstacle appears in this map.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewObstaclesForPath
Description

Register for notifications of new obstacles. for the given path. ObstacleReceiver.newObstacles() is invoked when a new Obstacle appears in this map.

Parametersosid.id.IdpathIdthe Id of the path to monitor
ErrorsNULL_ARGUMENT pathId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedObstacles
Description

Registers for notification of updated obstacles. ObstacleReceiver.changedObstacles() is invoked when an obstacle in this map is changed.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedObstacle
Description

Registers for notification of an updated obstacle. ObstacleReceiver.changedObstacles() is invoked when the specified obstacle in this map is changed.

Parametersosid.id.IdobstacleIdthe Id of the Obstacle to monitor
ErrorsNULL_ARGUMENT obstacleId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedObstaclesForPath
Description

Registers for notification of updated obstacles along the given path. ObstacleReceiver.changedObstacles() is invoked when an obstacle in this map is changed.

Parametersosid.id.IdpathIdthe Id of the Path to monitor
ErrorsNULL_ARGUMENT pathId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedObstacles
Description

Registers for notification of deleted obstacles. ObstacleReceiver.deletedObstacles() is invoked when an obstacle is deleted or removed from this map.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedObstacle
Description

Registers for notification of a deleted obstacle. ObstacleReceiver.deletedObstacles() is invoked when the specified obstacle is deleted or removed from this map.

Parametersosid.id.IdobstacleIdthe Id of the Obstacle to monitor
ErrorsNULL_ARGUMENT obstacleId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedObstaclesForPath
Description

Registers for notification of deleted obstacleq for the given path. ObstacleReceiver.deletedObstacles() is invoked when an obstacle is deleted or removed from this map.

Parametersosid.id.IdpathIdthe Id of the path to monitor
ErrorsNULL_ARGUMENT pathId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.