OSID - osid.metering.StatisticNotificationSession Service Interface Definition

Interface	osid.metering.StatisticNotificationSession
Implements	`osid.OsidSession`
Description	This session defines methods to receive notifications on statistics. 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	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	canRegisterForStatisticNotifications
Description	Tests if this user can register for `Statistic` 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 statistics 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 statistics to this utility only.
Compliance	`mandatory`		This method is must be implemented.
Method	registerForStatisticsExceedingSumThreshold
Description	Register for notifications sums exceeding a threshold. `StatisticReceiver.exceededSumThreshold()` is invoked when the sum exceeds the given value.
Parameters	`osid.id.Id`	`meterId`	the meter `Id`
	`cardinal`	`interval`	the time interval from the present
	`osid.calendaring.DateTimeResolution`	`units`	the date time units
	`decimal`	`value`	the threshold value
Errors	NULL_ARGUMENT		`meterId` or `units` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForStatisticsFailingSumThreshold
Description	Register for notifications sums failing a threshold. `StatisticReceiver.failedSumThreshold()` is invoked when the sum falls below the given value.
Parameters	`osid.id.Id`	`meterId`	the meter `Id`
	`cardinal`	`interval`	the time interval from the present
	`osid.calendaring.DateTimeResolution`	`units`	the date time units
	`decimal`	`value`	the threshold value
Errors	NULL_ARGUMENT		`meterId` or `units` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForStatisticsExceedingMeanThreshold
Description	Register for notifications of means exceeding a threshold. `StatisticReceiver.exceededMeanThreshold()` is invoked when the mean exceeds the given value.
Parameters	`osid.id.Id`	`meterId`	the meter `Id`
	`cardinal`	`interval`	the time interval from the present
	`osid.calendaring.DateTimeResolution`	`units`	the date time units
	`decimal`	`value`	the threshold value
Errors	NULL_ARGUMENT		`meterId` or `units` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForStatisticsFailingMeanThreshold
Description	Register for notifications means failing a threshold. `StatisticReceiver.failedMeanThreshold()` is invoked when the mean falls below the given value.
Parameters	`osid.id.Id`	`meterId`	the meter `Id`
	`cardinal`	`interval`	the time interval from the present
	`osid.calendaring.DateTimeResolution`	`units`	the date time units
	`decimal`	`value`	the threshold value
Errors	NULL_ARGUMENT		`meterId` or `units` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForStatisticsExceedingMedianThreshold
Description	Register for notifications of medians exceeding a threshold. `StatisticReceiver.exceededMeanThreshold()` is invoked when the median exceeds the given value.
Parameters	`osid.id.Id`	`meterId`	the meter `Id`
	`cardinal`	`interval`	the time interval from the present
	`osid.calendaring.DateTimeResolution`	`units`	the date time units
	`decimal`	`value`	the threshold value
Errors	NULL_ARGUMENT		`meterId` or `units` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForStatisticsFailingMedianThreshold
Description	Register for notifications of medians failing a threshold. `StatisticReceiver.failedMeanThreshold()` is invoked when the median falls below the given value.
Parameters	`osid.id.Id`	`meterId`	the meter `Id`
	`cardinal`	`interval`	the time interval from the present
	`osid.calendaring.DateTimeResolution`	`units`	the date time units
	`decimal`	`value`	the threshold value
Errors	NULL_ARGUMENT		`meterId` or `units` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForStatisticsExceedingRMSThreshold
Description	Register for notifications of the root mean square exceeding a threshold. `StatisticReceiver.exceededRMSThreshold()` is invoked when the rms exceeds the given value.
Parameters	`osid.id.Id`	`meterId`	the meter `Id`
	`cardinal`	`interval`	the time interval from the present
	`osid.calendaring.DateTimeResolution`	`units`	the date time units
	`decimal`	`value`	the threshold value
Errors	NULL_ARGUMENT		`meterId` or `units` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForStatisticsFailingRMSThreshold
Description	Register for notifications of the root mean square failing a threshold. `StatisticReceiver.failedRMSThreshold()` is invoked when the rms falls below the given value.
Parameters	`osid.id.Id`	`meterId`	the meter `Id`
	`cardinal`	`interval`	the time interval from the present
	`osid.calendaring.DateTimeResolution`	`units`	the date time units
	`decimal`	`value`	the threshold value
Errors	NULL_ARGUMENT		`meterId or units` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForStatisticsExceedingDeltaThreshold
Description	Register for notifications of the delta exceeding a threshold. `StatisticReceiver.exceededDeltaThreshold()` is invoked when the delta exceeds the given value.
Parameters	`osid.id.Id`	`meterId`	the meter `Id`
	`cardinal`	`interval`	the time interval from the present
	`osid.calendaring.DateTimeResolution`	`units`	the date time units
	`decimal`	`value`	the threshold value
Errors	NULL_ARGUMENT		`meterId` or `units` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForStatisticsFailingDeltaThreshold
Description	Register for notifications of the delta failing a threshold. `StatisticReceiver.failedDeltaThreshold()` is invoked when the delta falls below the given value.
Parameters	`osid.id.Id`	`meterId`	the meter `Id`
	`cardinal`	`interval`	the time interval from the present
	`osid.calendaring.DateTimeResolution`	`units`	the date time units
	`decimal`	`value`	the threshold value
Errors	NULL_ARGUMENT		`meterId` or `units` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForStatisticsExceedingPercentChangeThreshold
Description	Register for notifications of the percentage change exceeding a threshold. `StatisticReceiver.exceededPercentChangeThreshold()` is invoked when the change exceeds the given value.
Parameters	`osid.id.Id`	`meterId`	the meter `Id`
	`cardinal`	`interval`	the time interval from the present
	`osid.calendaring.DateTimeResolution`	`units`	the date time units
	`decimal`	`value`	the threshold value
Errors	NULL_ARGUMENT		`meterId` or `units` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForStatisticsFailingPercentChangeThreshold
Description	Register for notifications of the percentage change failing a threshold. `StatisticReceiver.failedPercentChangeThreshold()` is invoked when the change falls below the given value.
Parameters	`osid.id.Id`	`meterId`	the meter `Id`
	`cardinal`	`interval`	the time interval from the present
	`osid.calendaring.DateTimeResolution`	`units`	the date time units
	`decimal`	`value`	the threshold value
Errors	NULL_ARGUMENT		`meterId or units` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForStatisticsExceedingAverageRateThreshold
Description	Register for notifications of the rate exceeding a threshold. `StatisticReceiver.exceededAverageRateThreshold()` is invoked when the average rate exceeds the given value.
Parameters	`osid.id.Id`	`meterId`	the meter `Id`
	`cardinal`	`interval`	the time interval from the present
	`osid.calendaring.DateTimeResolution`	`units`	the date time units
	`decimal`	`value`	the threshold value
	`osid.calendaring.DateTimeResolution`	`rateInterval`	the time interval of the rate
Errors	NULL_ARGUMENT		`meterId, units,` or `rateInterval` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForStatisticsFailingAverageRateThreshold
Description	Register for notifications of the rate failing a threshold. `StatisticReceiver.failedAverageRateThreshold()` is invoked when the average rate falls below the given value.
Parameters	`osid.id.Id`	`meterId`	the meter `Id`
	`cardinal`	`interval`	the time interval from the present
	`osid.calendaring.DateTimeResolution`	`units`	the date time units
	`decimal`	`value`	the threshold value
	`osid.calendaring.DateTimeResolution`	`rateInterval`	the time interval of the rate
Errors	NULL_ARGUMENT		`meterId, units,` or `rateInterval` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.