OSID - osid.hierarchy.HierarchyStructureNotificationSession Service Interface Definition

Interface	osid.hierarchy.HierarchyStructureNotificationSession
Implements	`osid.OsidSession`
Description	This session defines methods to receive notifications on adds/changes to a hierarchical structure. 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. Notifications are triggered with changes to the structure of a hierarchy. For notifications of changes to the `Hierarchy` object use `HierarchyNotificationSession.`
Method	getHierarchyId
Description	Gets the hierarchy `Id` associated with this session.
Return	`osid.id.Id`		the hierarchy `Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getHierarchy
Description	Gets the `Hierarchy` associated with this session.
Return	`osid.hierarchy.Hierarchy`		the `Hierarchy` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForHierarchyStructureNotifications
Description	Tests if this user can register for `Hierarchy` 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	reliableHierarchyStructureNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeHierarchyStructureNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableHierarchyStructureNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeHierarchyStructureNotification
Description	Acknowledge a hierarchy structure 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	registerForNewHierarchyNodes
Description	Register for notifications of new hierarchy nodes. `HierarchyStructureReceiver.newNodes()` is invoked when a new `Hierarchy` node is added.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedHierarchyNodes
Description	Registers for notification of deleted hierarchy nodes. `HierarchyStructureReceiver.deletedNodes()` is invoked when a hierarchy ndoe is deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedHierarchyNode
Description	Registers for notification of a deleted hierarchy node. `HierarchyStructureReceiver.deletedNodes()` is invoked when the specified hierarchy node is deleted.
Parameters	`osid.id.Id`	`nodeId`	the `Id` of the `Hierarchy` 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	registerForChangedHierarchy
Description	Registers for notification of an updated hierarchy structure. `HierarchyStructureReceiver.changedChildOfNodes()` 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	registerForChangedHierarchyForAncestors
Description	Registers for notification of an updated hierarchy structure. `BillingReceiver.changedChildOfBillings()` is invoked when the specified node or any of its ancestors experiences a change in its children.
Parameters	`osid.id.Id`	`billingId`	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	registerForChangedHierarchyForDescendants
Description	Registers for notification of an updated hierarchy structure. `HierarchyStructureReceiver.changedChildOfNodes()` is invoked when the specified node or any of its descendants experiences a change in its children.
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.