OSID - osid.metering.UtilityNotificationSession Service Interface Definition

Interface	osid.metering.UtilityNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.metering.MeteringManager`
Used By	`osid.metering.MeteringProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `Utility` 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. Notifications are triggered with changes to the `Utility` object itself. Adding and removing entries result in notifications available from the notification session for meters.
Method	canRegisterForUtilityNotifications
Description	Tests if this user can register for `Utility` 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	registerForNewUtilities
Description	Register for notifications of new utilities. `UtilityReceiver.newUtilities()` is invoked when a new `Utility` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewUtilityAncestors
Description	Registers for notification of an updated hierarchy structure that introduces a new ancestor of the specified utility. `UtilityReceiver.newAncestorUtility()` is invoked when the specified utility node gets a new ancestor.
Parameters	`osid.id.Id`	`utilityId`	the `Id` of the `Utility` node to monitor
Errors	NULL_ARGUMENT		`utilityId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewUtilityDescendants
Description	Registers for notification of an updated hierarchy structure that introduces a new descendant of the specified utility. `UtilityReceiver.newDescendantUtility()` is invoked when the specified utility node gets a new descendant.
Parameters	`osid.id.Id`	`utilityId`	the `Id` of the `Utility` node to monitor
Errors	NULL_ARGUMENT		`utilityId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedUtilities
Description	Registers for notification of updated utilities. `UtilityReceiver.changedUtilities()` is invoked when a utility is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedUtility
Description	Registers for notification of an updated utility. `UtilityReceiver.changedUtilities()` is invoked when the specified utility is changed.
Parameters	`osid.id.Id`	`utilityId`	the `Id` of the `Utility` to monitor
Errors	NULL_ARGUMENT		`utilityId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedUtilities
Description	Registers for notification of deleted utilities. `UtilityReceiver.deletedUtilities()` is invoked when a utility is deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedUtility
Description	Registers for notification of a deleted utility. `UtilityReceiver.deletedUtilities()` is invoked when the specified utility is deleted.
Parameters	`osid.id.Id`	`utilityId`	the `Id` of the `Utility` to monitor
Errors	NULL_ARGUMENT		`utilityId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedUtilityAncestors
Description	Registers for notification of an updated hierarchy structure that removes an ancestor of the specified utility. `UtilityReceiver.deletedAncestor()` is invoked when the specified utility node loses an ancestor.
Parameters	`osid.id.Id`	`utilityId`	the `Id` of the `Utility` node to monitor
Errors	NULL_ARGUMENT		`utilityId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedUtilityDescendants
Description	Registers for notification of an updated hierarchy structure that removes a descendant of the specified utility. `UtilityReceiver.deletedDescendant()` is invoked when the specified utility node loses a descendant.
Parameters	`osid.id.Id`	`utilityId`	the `Id` of the `Utility` node to monitor
Errors	NULL_ARGUMENT		`utilityId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	acknowledgeUtilityNotification
Description	Acknowledge a utility 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	registerForChangedUtilityHierarchy
Description	Registers for notification of an updated utility hierarchy structure. `UtilityReceiver.changedChildOfUtilities()` 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	registerForChangedUtilityHierarchyForAncestors
Description	Registers for notification of an updated utility hierarchy structure. `UtilityReceiver.changedChildOfUtilities()` is invoked when a node experiences a change in its children.
Parameters	`osid.id.Id`	`utilityId`	the `Id` of the `Utility` node to monitor
Errors	NULL_ARGUMENT		`utilityId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedUtilityHierarchyForDescendants
Description	Registers for notification of an updated utility hierarchy structure. `UtilityReceiver.changedChildOfUtilities()` is invoked when a node experiences a change in its children.
Parameters	`osid.id.Id`	`utilityId`	the `Id` of the `Utility` node to monitor
Errors	NULL_ARGUMENT		`utilityId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.