OSID - osid.metering.MeterNotificationSession Service Interface Definition

Interface	osid.metering.MeterNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.metering.MeteringManager`
Used By	`osid.metering.MeteringProxyManager`
Description	This session defines methods to receive notifications on new or deleted meters. 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. This session registers notifications for the Meter itself.
Method	getUtilityId
Description	Gets the `Utility` `Id` associated with this session.
Return	`osid.id.Id`		the `Utility Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getUtility
Description	Gets the `Utility` associated with this session.
Return	`osid.metering.Utility`		the `Utility` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForMeterNotifications
Description	Tests if this user can register for `Meter` 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	useFederatedUtilityView
Description	Federates the view for methods in this session. A federated view will include meters from parent utilities in the utility hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedUtilityView
Description	Isolates the view for methods in this session. An isolated view restricts notifications for meters to this utility only.
Compliance	`mandatory`		This method is must be implemented.
Method	registerForNewMeters
Description	Register for notifications of new meters. `MeterReceiver.newMeters()` is invoked when a new `Meter` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedMeters
Description	Register for notifications of new meters. `MeterReceiver.changedMeters()` is invoked when a `Meter` is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedMeter
Description	Registers for notification of an updated meter. `MeterReceiver.changedMeters()` is invoked when the specified meter in this utility is changed.
Parameters	`osid.id.Id`	`meterId`	the `Id` of the `Meter` to monitor
Errors	NULL_ARGUMENT		`meterId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedMeters
Description	Registers for notification of deleted meters. `MeterReceiver.deletedMeters()` is invoked when a meter is deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedMeter
Description	Registers for notification of a deleted meter. `MeterReceiver.deletedMeters()` is invoked when the specified meter is deleted or removed from this utility.
Parameters	`osid.id.Id`	`meterId`	the `Id` of the `Meter` to monitor
Errors	NULL_ARGUMENT		`meterId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	acknowledgeMeterNotification
Description	Acknowledge a meter 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.