OSID - osid.mapping.path.rules.ObstacleEnablerNotificationSession Service Interface Definition

Interface	osid.mapping.path.rules.ObstacleEnablerNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.mapping.path.rules.MappingPathRulesManager`
Used By	`osid.mapping.path.rules.MappingPathRulesProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `ObstacleEnabler` objects in this `Map` . This also includes existing `ObstacleEnablers` 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 `ObstacleEnablerLookupSession` .
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	canRegisterForObstacleEnablerNotifications
Description	Tests if this user can register for `ObstacleEnabler` 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 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	reliableObstacleEnablerNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeObstacleEnablerNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableObstacleEnablerNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeObstacleEnablerNotification
Description	Acknowledge an obstacle enabler 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	registerForNewObstacleEnablers
Description	Register for notifications of new obstacle enablers. `ObstacleEnablerReceiver.newObstacleEnablers()` is invoked when a new `ObstacleEnabler` appears in this map.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedObstacleEnablers
Description	Registers for notification of updated map. `ObstacleEnablerReceiver.changedObstacleEnablers()` is invoked when an obstacle enabler 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	registerForChangedObstacleEnabler
Description	Registers for notification of an updated obstacle enabler. `ProvisionableReceiver.changedObstacleEnablers()` is invoked when the specified obstacle enabler in this map is changed.
Parameters	`osid.id.Id`	`obstacleEnablerId`	the `Id` of the `ObstacleEnabler` to monitor
Errors	NOT_FOUND		an obstacle enabler was not found in this broker matchmaker identified by the given `Id`
	NULL_ARGUMENT		`obstacleEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedObstacleEnablers
Description	Registers for notification of deleted obstacle enablers. `ObstacleEnablerReceiver.deletedObstacleEnablers()` is invoked when an obstacle enabler 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	registerForDeletedObstacleEnabler
Description	Registers for notification of a deleted obstacle enabler. `ObstacleEnablerReceiver.deletedObstacleEnablers()` is invoked when the specified obstacle enabler is deleted or removed from this map.
Parameters	`osid.id.Id`	`obstacleEnablerId`	the `Id` of the `ObstacleEnabler` to monitor
Errors	NOT_FOUND		an obstacle enabler was not found in this broker matchmaker identified by the given `Id`
	NULL_ARGUMENT		`obstacleEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.