OSID - osid.topology.NodeNotificationSession Service Interface Definition

Interface	osid.topology.NodeNotificationSession
Implements	`osid.OsidSession`
Description	This session defines methods to receive notifications on adds/changes to `Node` objects in this `Graph.` This also includes existing nodes 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 `NodeLookupSession.`
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	canRegisterForNodeNotifications
Description	Tests if this user can register for `Node` 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 nodes 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	reliableNodeNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeNodeNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableNodeNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeNodeNotification
Description	Acknowledge a node 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	registerForNewNodes
Description	Register for notifications of new nodes. `NodeReceiver.newNodes()` is invoked when a new `Node` appears in this graph.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedNodes
Description	Registers for notification of updated nodes. `NodeReceiver.changedNodes()` is invoked when a node 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	registerForChangedNode
Description	Registers for notification of an updated node. `NodeReceiver.changedNodes()` is invoked when the specified node 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	registerForDeletedNodes
Description	Registers for notification of deleted nodes. `NodeReceiver.deletedNodes()` is invoked when a node 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	registerForDeletedNode
Description	Registers for notification of a deleted node. `NodeReceiver.deletedNodes()` is invoked when the specified node is deleted or removed from this graph.
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.