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

Interface	osid.mapping.path.PathNotificationSession
Implements	`osid.OsidSession`
Description	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	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	canRegisterForPathNotifications
Description	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.
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 paths 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	registerForNewPaths
Description	Register for notifications of new paths. `PathReceiver.newPaths()` is invoked when a new `Path` appears in this map.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewPathsThroughLocation
Description	Register for notifications of new paths through the given location. `PathReceiver.newPaths()` is invoked when a new `Path` appears in this map.
Parameters	`osid.id.Id`	`locationId`	the `Id` of the `Location` to monitor
Errors	NULL_ARGUMENT		`locationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedPaths
Description	Registers for notification of updated paths. `PathReceiver.changedPaths()` is invoked when a path 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	registerForChangedPathsThroughLocation
Description	Register for notifications of updated paths through the given location. `PathReceiver.changedPaths()` is invoked when a path is changed in this map.
Parameters	`osid.id.Id`	`locationId`	the `Id` of the `Location` to monitor
Errors	NULL_ARGUMENT		`locationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedPath
Description	Registers for notification of an updated path. `PathReceiver.changedPaths()` is invoked when the specified path 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	registerForDeletedPaths
Description	Registers for notification of deleted paths. `PathReceiver.deletedPaths()` is invoked when a path 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	registerForDeletedPathsThroughLocation
Description	Register for notifications of deleted paths through the given location. `PathReceiver.deletedPaths()` is invoked when a path is removed from this map.
Parameters	`osid.id.Id`	`locationId`	the `Id` of the `Location` to monitor
Errors	NULL_ARGUMENT		`locationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedPath
Description	Registers for notification of a deleted path. `PathReceiver.deletedPaths()` is invoked when the specified path 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.