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

Interface	osid.topology.path.PathNotificationSession
Implements	`osid.OsidSession`
Description	This session defines methods to receive notifications on adds/changes to `Path` objects in this `Graph.` This also includes existing paths that may appear or disappear due to changes in the `Graph` 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	getGraphId
Description	Gets the `Graph` `Id` associated with this session.
Return	`osid.id.Id`		the `Graph Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getGraph
Description	Gets the `Graph` associated with this session.
Return	`osid.topology.Graph`		the graph
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	useFederatedGraphView
Description	Federates the view for methods in this session. A federated view will include paths in graphs which are children of this graph in the graph hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedGraphView
Description	Isolates the view for methods in this session. An isolated view restricts notifications to this graph only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliablePathNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgePathNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliablePathNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgePathNotification
Description	Acknowledge a path 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	registerForNewPaths
Description	Register for notifications of new paths. `PathReceiver.newPaths()` is invoked when a new `Path` appears in this graph.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewPathsByGenusType
Description	Register for notifications of new paths of the given genus type. `PathReceiver.newPaths()` is invoked when a new `Path` is connected to the specified location.
Parameters	`osid.type.Type`	`pathGenusType`	a path genus type
Errors	NULL_ARGUMENT		`pathGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewPathsForStartingNode
Description	Register for notifications of new paths from the given node. `PathReceiver.newPaths()` is invoked when a new `Path` is connected to the specified location.
Parameters	`osid.id.Id`	`nodeId`	the `Id` of the `Node` to monitor
Errors	NULL_ARGUMENT		`nodeId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewPathsForEndingNode
Description	Register for notifications of new paths to the given node. `PathReceiver.newPaths()` is invoked when a new `Path` is connected to the specified location.
Parameters	`osid.id.Id`	`nodeId`	the `Id` of the `Node` to monitor
Errors	NULL_ARGUMENT		`nodeId` 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 graph is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedPathsByGenusType
Description	Registers for notification of updated paths of the given genus type. `PathReceiver.changedPaths()` is invoked when a path in this graph is changed.
Parameters	`osid.type.Type`	`pathGenusType`	a path genus type
Errors	NULL_ARGUMENT		`pathGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedPathsForStartingNode
Description	Registers for notification of updated paths from the given node. `PathReceiver.changedPaths()` is invoked when a path in this graph is changed.
Parameters	`osid.id.Id`	`nodeId`	the `Id` of the `Node` to monitor
Errors	NULL_ARGUMENT		`nodeId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedPathsForEndingNode
Description	Registers for notification of updated paths to the given node. `PathReceiver.changedPaths()` is invoked when a path in this graph is changed.
Parameters	`osid.id.Id`	`nodeId`	the `Id` of the `Node` to monitor
Errors	NULL_ARGUMENT		`nodeId` 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 graph 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 graph.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedPathsByGenusType
Description	Registers for notification of deleted paths of the given genus type. `PathReceiver.deletedPatsh()` is invoked when a path is deleted or removed from this graph.
Parameters	`osid.type.Type`	`pathGenusType`	a path genus type
Errors	NULL_ARGUMENT		`pathGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedPathsForStartingNode
Description	Register for notifications of removed paths from the given node. `PathReceiver.deletedPaths()` is invoked when a new `Path` is removed from the specified location.
Parameters	`osid.id.Id`	`nodeId`	the `Id` of the `Node` to monitor
Errors	NULL_ARGUMENT		`nodeId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedPathsForEndingNode
Description	Register for notifications of removed paths to the given node. `PathReceiver.deletedPaths()` is invoked when a new `Path` is removed from the specified location.
Parameters	`osid.id.Id`	`nodeId`	the `Id` of the `Node` to monitor
Errors	NULL_ARGUMENT		`nodeId` 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 graph.
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.