OSID - osid.topology.GraphNotificationSession Service Interface Definition

Interface	osid.topology.GraphNotificationSession
Implements	`osid.OsidSession`
Description	This session defines methods to receive notifications on adds/changes to `Graph` objects. 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	canRegisterForGraphNotifications
Description	Tests if this user can register for `Graph` 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	reliableGraphNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeGrapNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableGraphNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeGraphNotification
Description	Acknowledge a graph 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	registerForNewGraphs
Description	Register for notifications of new graphs. `GraphReceiver.newGraphs()` is invoked when a new `Graph` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedGraphs
Description	Registers for notification of updated graphs. `GraphReceiver.changedGraphs()` is invoked when a graph is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedGraph
Description	Registers for notification of an updated graph. `GraphReceiver.changedGraphs()` is invoked when the specified graph is changed.
Parameters	`osid.id.Id`	`graphId`	the Id of the `Graph` to monitor
Errors	NULL_ARGUMENT		`graphId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedGraphs
Description	Registers for notification of deleted graphs. `GraphReceiver.deletedGraphs()` is invoked when a graph is deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedGraph
Description	Registers for notification of a deleted graph. `GraphReceiver.deletedGraphs()` is invoked when the specified graph is deleted.
Parameters	`osid.id.Id`	`graphId`	the `Id` of the `Graph` to monitor
Errors	NULL_ARGUMENT		`graphId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedGraphHierarchy
Description	Registers for notification of an updated graph hierarchy structure. `GraphReceiver.changedChildOfGraphs()` is invoked when a node experiences a change in its children.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedGraphHierarchyForAncestors
Description	Registers for notification of an updated graph hierarchy structure. `GraphReceiver.changedChildOfGraphs()` is invoked when the specified node or any of its ancestors experiences a change in its children.
Parameters	`osid.id.Id`	`graphId`	the `Id` of the `Graph` node to monitor
Errors	NULL_ARGUMENT		`graphId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedGraphHierarchyForDescendants
Description	Registers for notification of an updated graph hierarchy structure. `GraphReceiver.changedChildOfGraphs()` is invoked when the specified node or any of its descendants experiences a change in its children.
Parameters	`osid.id.Id`	`graphId`	the `Id` of the `Graph` node to monitor
Errors	NULL_ARGUMENT		`graphId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.