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

Interface	osid.mapping.path.ResourcePathNotificationSession
Implements	`osid.OsidSession`
Description	This session defines methods to receive notifications on adds/changes to resources on paths in this `Map.` 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.
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	canRegisterForResourcePathNotifications
Description	Tests if this user can register for 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 wish not to offer notification operations to unauthorized users.
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	registerForEnteredPaths
Description	Register for notifications of resource starting on paths. `ResourcePathReceiver.enteredPath()` is invoked when a resource turns on to a path.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForEnteredPath
Description	Register for notifications of resources starting on paths. `ResourcePathReceiver.enteredPath()` is invoked when a resource turns on to the specified path.
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	registerForEnteredPathsForResource
Description	Register for notifications of a started path. `ResourcePathReceiver.enteredPath()` is invoked when the specified resource begins a path.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the `Resource` to monitor
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForEnteredPathsForResourcesByGenusType
Description	Register for notifications of a started path for resources of the given genus type. `ResourcePathReceiver.enteredPath()` is invoked when the specified resource begins a path.
Parameters	`osid.type.Type`	`resourceGenusType`	the genus type of the `Resource` to monitor
Errors	NULL_ARGUMENT		`resourceGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForExitedPaths
Description	Register for notifications of resource exits paths. `ResourcePathReceiver.exitedPath()` is invoked when a resource turns leaves a path.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForExitedPath
Description	Register for notifications of resources exits paths. `ResourcePathReceiver.exitedPath()` is invoked when a resource leaves the specified path.
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	registerForExitedPathsForResource
Description	Register for notifications of an exited path. `ResourcePathReceiver.exitedPath()` is invoked when the specified resource leaves a path.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the `Resource` to monitor
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForExitedPathsForResourcesByGenusType
Description	Register for notifications of an exited path for resources of the given genus type. `ResourcePathReceiver.exitedPath()` is invoked when the specified resource leaves a path.
Parameters	`osid.type.Type`	`resourceGenusType`	the genus type of the `Resource` to monitor
Errors	NULL_ARGUMENT		`resourceGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.