OSID - osid.hierarchy.HierarchyNotificationSession Service Interface Definition

Interface	osid.hierarchy.HierarchyNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.hierarchy.HierarchyManager`
Used By	`osid.hierarchy.HierarchyProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `Hierarchies`. 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 `Hierarchy` object itself. Adding and removing `Ids` result in notifications available from the `HierarchyNodeNotificationSession`.
Method	canRegisterForHierarchyNotifications
Description	Tests if this user can register for `Hierarchy` 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	reliableHierarchyNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeHierarchyNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableHierarchyNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeHierarchyNotification
Description	Acknowledge a hierarchy 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	registerForNewHierarchies
Description	Register for notifications of new hierarchies. `HierarchyReceiver.newHierarchies()` is invoked when a new `Hierarchy` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedHierarchies
Description	Registers for notification of updated hierarchies. `HierarchyReceiver.changedHierarchies()` is invoked when a hierarchy is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedHierarchy
Description	Registers for notification of an updated hierarchy. `HierarchyReceiver.changedHierarchies()` is invoked when the specified hierarchy is changed.
Parameters	`osid.id.Id`	`hierarchyId`	the `Id` of the `hierarchy` to monitor
Errors	NULL_ARGUMENT		`hierarchyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedHierarchies
Description	Registers for notification of deleted hierarchies. `HierarchyReceiver.deletedHierarchies()` is invoked when a hierarchy is deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedHierarchy
Description	Registers for notification of a deleted hierarchy. `HierarchyReceiver.deletedHierarchies()` is invoked when the specified hierarchy is deleted.
Parameters	`osid.id.Id`	`hierarchyId`	the `Id` of the `Hierarchy` to monitor
Errors	NULL_ARGUMENT		`hierarchyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.