OSID - osid.topology.EdgeNotificationSession Service Interface Definition

Interface	osid.topology.EdgeNotificationSession
Implements	`osid.OsidSession`
Description	This session defines methods to receive notifications on adds/changes to `Edge` objects in this `Graph.` This also includes existing edges 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 `EdgeLookupSession.`
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	canRegisterForEdgeNotifications
Description	Tests if this user can register for `Edge` 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 edges 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	reliableEdgeNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeEDgeNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableEdgeNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeEdgeNotification
Description	Acknowledge an edge 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	registerForNewEdges
Description	Register for notifications of new edges. `EdgeReceiver.newEdges()` is invoked when a new `Edge` appears in this graph.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewEdgesByGenusType
Description	Register for notifications of new edges by genus type. `EdgeReceiver.newEdges()` is invoked when a new `Edge` is connected to the specified node.
Parameters	`osid.type.Type`	`edgeGenusType`	an edge genus type
Errors	NULL_ARGUMENT		`edgeGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewEdgesForSourceNode
Description	Register for notifications of new edges from a specified node. `EdgeReceiver.newEdges()` is invoked when a new `Edge` is connected to the specified node.
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	registerForNewEdgesForDestinationNode
Description	Register for notifications of new edges to a specified node. `EdgeReceiver.newEdges()` is invoked when a new `Edge` is connected to the specified node.
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	registerForChangedEdges
Description	Registers for notification of updated edges. `EdgeReceiver.changedEdges()` is invoked when an edge 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	registerForChangedEdgesByGenusType
Description	Register for notifications of updated edges by genus type. `EdgeReceiver.changedEdges()` is invoked when an `Edge` in this graph is changed.
Parameters	`osid.type.Type`	`edgeGenusType`	an edge genus type
Errors	NULL_ARGUMENT		`edgeGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedEdgesForSourceNode
Description	Register for notifications of updated edges from a specified node. `EdgeReceiver.changedEdgeConnection()` is invoked when an `Edge` 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	registerForChangedEdgesForDestinationNode
Description	Register for notifications of updated edges to a specified node. `EdgeReceiver.changedEdges()` is invoked when an `Edge` 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	registerForChangedEdge
Description	Registers for notification of an updated edge. `EdgeReceiver.changedEdges()` is invoked when the specified edge in this graph is changed.
Parameters	`osid.id.Id`	`edgeId`	the `Id` of the `Edge` to monitor
Errors	NULL_ARGUMENT		`edgeId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedEdges
Description	Registers for notification of deleted edges. `EdgeReceiver.deletedEdges()` is invoked when an edge 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	registerForDeletedEdgesByGenusType
Description	Register for notifications of deleted edges by genus type. `EdgeReceiver.deletedEdges()` is invoked when an `Edge` in this graph is removed.
Parameters	`osid.type.Type`	`edgeGenusType`	an edge genus type
Errors	NULL_ARGUMENT		`edgeGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedEdgesForSourceNode
Description	Register for notifications of new edges from a specified node. `EdgeReceiver.deletedEdges()` is invoked when a new `Edge` is connected to the specified node.
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	registerForDeletedEdgesForDestinationNode
Description	Register for notifications of new edges to a specified node. `EdgeReceiver.deletedEdges()` is invoked when a new `Edge` is connected to the specified node.
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	registerForDeletedEdge
Description	Registers for notification of a deleted edge. `EdgeReceiver.deletedEdges()` is invoked when the specified edge is deleted or removed from this graph.
Parameters	`osid.id.Id`	`edgeId`	the `Id` of the `Edge` to monitor
Errors	NULL_ARGUMENT		`edgeId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.