OSID - osid.mapping.path.ObstacleNotificationSession Service Interface Definition

Interface	osid.mapping.path.ObstacleNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.mapping.path.MappingPathManager`
Used By	`osid.mapping.path.MappingPathProxyManager`
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`.
Method	getMapId
Description	Gets the `Map` `Id` associated with this session.
Return	`osid.id.Id`		the `Map Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getMap
Description	Gets the `Map` associated with this session.
Return	`osid.mapping.Map`		the map
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForObstacleNotifications
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.
Return	`boolean`		`false` if notification methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useFederatedMapView
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.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedMapView
Description	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.
Method	acknowledgeObstacleNotification
Description	Acknowledge a obstacle notification.
Parameters	`osid.id.Id`	`notificationId`	the `Id` of the notification
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewObstacles
Description	Register for notifications of new obstacles. `ObstacleReceiver.newObstacles()` is invoked when a new `Obstacle` appears in this map.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewObstaclesForPath
Description	Register for notifications of new obstacles. for the given path. `ObstacleReceiver.newObstacles()` is invoked when a new `Obstacle` appears in this map.
Parameters	`osid.id.Id`	`pathId`	the `Id` of the path to monitor
Errors	NULL_ARGUMENT		`pathId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedObstacles
Description	Registers for notification of updated obstacles. `ObstacleReceiver.changedObstacles()` is invoked when an obstacle in this map is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedObstacle
Description	Registers for notification of an updated obstacle. `ObstacleReceiver.changedObstacles()` is invoked when the specified obstacle in this map is changed.
Parameters	`osid.id.Id`	`obstacleId`	the `Id` of the `Obstacle` to monitor
Errors	NULL_ARGUMENT		`obstacleId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedObstaclesForPath
Description	Registers for notification of updated obstacles along the given path. `ObstacleReceiver.changedObstacles()` is invoked when an obstacle in this map is changed.
Parameters	`osid.id.Id`	`pathId`	the `Id` of the `Path` to monitor
Errors	NULL_ARGUMENT		`pathId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedObstacles
Description	Registers for notification of deleted obstacles. `ObstacleReceiver.deletedObstacles()` is invoked when an obstacle is deleted or removed from this map.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedObstacle
Description	Registers for notification of a deleted obstacle. `ObstacleReceiver.deletedObstacles()` is invoked when the specified obstacle is deleted or removed from this map.
Parameters	`osid.id.Id`	`obstacleId`	the `Id` of the `Obstacle` to monitor
Errors	NULL_ARGUMENT		`obstacleId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedObstaclesForPath
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.
Parameters	`osid.id.Id`	`pathId`	the `Id` of the path to monitor
Errors	NULL_ARGUMENT		`pathId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.