OSID - osid.metering.MeteringManager Service Interface Definition

Interface	osid.metering.MeteringManager
Implements	`osid.OsidManager`
Implements	`osid.metering.MeteringProfile`
Description	The metering manager provides access to metering sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are: `MeterReadingSession:` a session to write to a utility `StatisticLookupSession:` a session for retrieving some statistics from a meter `StatisticQuerySession:` a session for querying statistics `StatisticSearchSession:` a session for searching statistics `StatisticNotificationSession:` a session for subscribing to statistical notifications `StatisticSmartUtilitySession:` a session for managing smart utilities of statistics `MeterLookupSession:` a session to look up meters `MeterQuerySession:` a session to query meters `MeterSearchSession:` a session to search meters `MeterAdminSession:` a session to manage meters `MeterNotificationSession:` a session to subscribe to notifications of new or changed meters `MeterUtilitySession:` a session to look up meter to utility mappings `MeterUtilityAssignmentSession:` a session to manage meter to utility mappings `MeterSmartUtilitySession:` a session tomanage meter smart utilities `UtilityLookupSession:` a session to retrieve utility objects `UtilityQuerySession:` a session to query utilities `UtilitySearchSession:` a session to search for utilities `UtilityAdminSession:` a session to create, update and delete utilities `UtilityNotificationSession:` a session to receive notifications for changes in utilities `UtilityHierarchyTraversalSession:` a session to traverse hierarchies of utilities `UtilityHierarchyDesignSession:` a session to manage hierarchues of utilities The metering manager also provides a profile for determing the supported search types supported by this service.
Method	getMeterReadingSession
Description	Gets the `OsidSession` associated with the meter reading service.
Return	`osid.metering.MeterReadingSession`		a `MeterReadingSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsMeterReading()` is `false`
Compliance	`optional`		This method must be implemented if `supportsMeterReading()` is `true.`
Method	getMeterReadingSessionForUtility
Description	Gets the `OsidSession` associated with the meter reading service for the given utility.
Parameters	`osid.id.Id`	`utilityId`	the `Id` of the `Utility`
Return	`osid.metering.MeterReadingSession`		a `MeterReadingSession`
Errors	NOT_FOUND		no `Utility` found by the given `Id`
	NULL_ARGUMENT		`utilityId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsMeterReading()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsMeterReading()` and `supportsVisibleFederation()` are `true`
Method	getStatisticLookupSession
Description	Gets the `OsidSession` associated with the statistic lookup service.
Return	`osid.metering.StatisticLookupSession`		a `StatisticLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsStatisticLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsStatisticLookup()` is `true.`
Method	getStatisticLookupSessionForUtility
Description	Gets the `OsidSession` associated with the statistic lookup service for the given utility.
Parameters	`osid.id.Id`	`utilityId`	the `Id` of the `Utility`
Return	`osid.metering.StatisticLookupSession`		a `StatisticLookupSession`
Errors	NOT_FOUND		no `Utility` found by the given `Id`
	NULL_ARGUMENT		`utilityId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsStatisticLookup()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsStatisticLookup()` and `supportsVisibleFederation()` are `true`
Method	getStatisticQuerySession
Description	Gets the `OsidSession` associated with the statistic query service.
Return	`osid.metering.StatisticQuerySession`		a `StatisticQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsStatisticQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsStatisticQuery()` is `true.`
Method	getStatisticQuerySessionForUtility
Description	Gets the `OsidSession` associated with the statistic query service for the given utility.
Parameters	`osid.id.Id`	`utilityId`	the `Id` of the `Utility`
Return	`osid.metering.StatisticQuerySession`		a `StatisticQuerySession`
Errors	NOT_FOUND		no `Utility` found by the given `Id`
	NULL_ARGUMENT		`utilityId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsStatisticQuery()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsStatisticQuery()` and `supportsVisibleFederation()` are `true`
Method	getStatisticSearchSession
Description	Gets the `OsidSession` associated with the statistic search service.
Return	`osid.metering.StatisticSearchSession`		a `StatisticSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsStatisticSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsStatisticSearch()` is `true.`
Method	getStatisticSearchSessionForUtility
Description	Gets the `OsidSession` associated with the statistic search service for the given utility.
Parameters	`osid.id.Id`	`utilityId`	the `Id` of the `Utility`
Return	`osid.metering.StatisticSearchSession`		a `StatisticSearchSession`
Errors	NOT_FOUND		no `Utility` found by the given `Id`
	NULL_ARGUMENT		`utilityId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsStatisticSearch()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsStatisticSearch()` and `supportsVisibleFederation()` are `true`
Method	getStatisticNotificationSession
Description	Gets the `OsidSession` associated with the statistic notification service.
Parameters	`osid.metering.StatisticReceiver`	`statisticReceiver`	the receiver
Return	`osid.metering.MeterNotificationSession`		a `StatisticNotificationSession`
Errors	NULL_ARGUMENT		`statisticReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsStatisticNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsMeterNotification()` is `true.`
Method	getStatisticNotificationSessionForUtility
Description	Gets the `OsidSession` associated with the statistic notification service for the given utility.
Parameters	`osid.metering.StatisticReceiver`	`statisticReceiver`	the receiver
Parameters	`osid.id.Id`	`utilityId`	the `Id` of the `Utility`
Return	`osid.metering.MeterNotificationSession`		a `StatisticNotificationSession`
Errors	NOT_FOUND		no `Utility` found by the given `Id`
	NULL_ARGUMENT		`statisticReceiver` or `utilityId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsStatisticNotification()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsStatisticNotification()` and `supportsVisibleFederation()` are `true`
Method	getStatisticSmartUtilitySession
Description	Gets the `OsidSession` associated with the statistic smart utility session.
Parameters	`osid.id.Id`	`utilityId`	the `Id` of the `Utility`
Return	`osid.metering.StatisticSmartUtilitySession`		a `StatisticSmartUtilitySession`
Errors	NOT_FOUND		no `Utility` found by the given `Id`
	NULL_ARGUMENT		`utilityId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsStatisticSmartUtility()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsStatisticUtility()` and `supportsVisibleFederation()` are `true`
Method	getMeterLookupSession
Description	Gets the `OsidSession` associated with the meter lookup service.
Return	`osid.metering.MeterLookupSession`		a `MeterLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsMeterLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsMeterLookup()` is `true.`
Method	getMeterLookupSessionForUtility
Description	Gets the `OsidSession` associated with the meter lookup service for the given utility.
Parameters	`osid.id.Id`	`utilityId`	the `Id` of the `Utility`
Return	`osid.metering.MeterLookupSession`		a `MeterLookupSession`
Errors	NOT_FOUND		no `Utility` found by the given `Id`
	NULL_ARGUMENT		`utilityId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsMeterLookup()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsMeterLookup()` and `supportsVisibleFederation()` are `true`
Method	getMeterQuerySession
Description	Gets the `OsidSession` associated with the meter query service.
Return	`osid.metering.MeterQuerySession`		a `MeterQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsMeterQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsMeterQuery()` is `true.`
Method	getMeterQuerySessionForUtility
Description	Gets the `OsidSession` associated with the meter query service for the given utility.
Parameters	`osid.id.Id`	`utilityId`	the `Id` of the `Utility`
Return	`osid.metering.MeterQuerySession`		a `MeterQuerySession`
Errors	NOT_FOUND		no Utility found by the given Id
	NULL_ARGUMENT		`utilityId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsMeterQuery()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsMeterQuery()` and `supportsVisibleFederation()` are `true`
Method	getMeterSearchSession
Description	Gets the `OsidSession` associated with the metering search service.
Return	`osid.metering.MeterSearchSession`		a `MeterSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsMeterSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsMeterSearch()` is `true.`
Method	getMeterSearchSessionForUtility
Description	Gets the `OsidSession` associated with the meter search service for the given utility.
Parameters	`osid.id.Id`	`utilityId`	the `Id` of the `Utility`
Return	`osid.metering.MeterSearchSession`		a `MeterSearchSession`
Errors	NOT_FOUND		no `Utility` found by the given `Id`
	NULL_ARGUMENT		`utilityId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsMeterSearch()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsMeterSearch()` and `supportsVisibleFederation()` are `true`
Method	getMeterAdminSession
Description	Gets the `OsidSession` associated with the meter administrative service.
Return	`osid.metering.MeterAdminSession`		a `MeterAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsMeterAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsMeterAdmin()` is `true.`
Method	getMeterAdminSessionForUtility
Description	Gets the `OsidSession` associated with the meter administrative service for the given utility.
Parameters	`osid.id.Id`	`utilityId`	the `Id` of the `Utility`
Return	`osid.metering.MeterAdminSession`		a `MeterAdminSession`
Errors	NOT_FOUND		no `Utility` found by the given `Id`
	NULL_ARGUMENT		`utilityId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsMeterAdmin()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsMeterAdmin()` and `supportsVisibleFederation()` are `true`
Method	getMeterNotificationSession
Description	Gets the `OsidSession` associated with the meter notification service.
Parameters	`osid.metering.MeterReceiver`	`meterReceiver`	the receiver
Return	`osid.metering.MeterNotificationSession`		a `MeterNotificationSession`
Errors	NULL_ARGUMENT		`meterReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsMeterNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsMeterNotification()` is `true.`
Method	getMeterNotificationSessionForUtility
Description	Gets the `OsidSession` associated with the meter notification service for the given utility.
Parameters	`osid.metering.MeterReceiver`	`meterReceiver`	the receiver
Parameters	`osid.id.Id`	`utilityId`	the `Id` of the `Utility`
Return	`osid.metering.MeterNotificationSession`		a `MeterNotificationSession`
Errors	NOT_FOUND		no `Utility` found by the given `Id`
	NULL_ARGUMENT		`meterReceiver` or `utilityId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsMeterNotification()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsMeterNotification()` and `supportsVisibleFederation()` are `true`
Method	getMeterUtilitySession
Description	Gets the `OsidSession` associated with looking up mapping of meters and utilities.
Return	`osid.metering.MeterUtilitySession`		a `MeterUtilitySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsMeterUtility()` is `false`
Compliance	`optional`		This method must be implemented if `supportsMeterUtility()` is `true.`
Method	getMeterUtilityAssignmentSession
Description	Gets the `OsidSession` associated with managing the mapping of meters and utilities.
Return	`osid.metering.MeterUtilityAssignmentSession`		a `MeterUtilityAssignmentSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsMeterUtilityAssignment()` is `false`
Compliance	`optional`		This method must be implemented if `supportsMeterUtilityAssignment()` is `true.`
Method	getMeterSmartUtilitySession
Description	Gets the `OsidSession` associated with the meter smart utility session.
Parameters	`osid.id.Id`	`utilityId`	the `Id` of the `Utility`
Return	`osid.metering.MeterSmartUtilitySession`		a `MeterSmartUtilitySession`
Errors	NOT_FOUND		no `Utility` found by the given `Id`
	NULL_ARGUMENT		`utilityId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsMeterSmartUtility()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsMeterUtility()` and `supportsVisibleFederation()` are `true`
Method	getUtilityLookupSession
Description	Gets the `OsidSession` associated with the utility lookup service.
Return	`osid.metering.UtilityLookupSession`		a `UtilityLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsUtilityLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsUtilityLookup()` is `true.`
Method	getUtilityQuerySession
Description	Gets the `OsidSession` associated with the utility query service.
Return	`osid.metering.UtilityQuerySession`		a `UtilityQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsUtilityQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsUtilityQuery()` is `true.`
Method	getUtilitySearchSession
Description	Gets the `OsidSession` associated with the utility search service.
Return	`osid.metering.UtilitySearchSession`		a `UtilitySearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsUtilitySearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsUtilitySearch()` is `true.`
Method	getUtilityAdminSession
Description	Gets the `OsidSession` associated with the utility administrative service.
Return	`osid.metering.UtilityAdminSession`		a `UtilityAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsUtilityAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsUtilityAdmin()` is `true.`
Method	getUtilityNotificationSession
Description	Gets the `OsidSession` associated with the utility notification service.
Parameters	`osid.metering.UtilityReceiver`	`utilityReceiver`	the receiver
Return	`osid.metering.UtilityNotificationSession`		a `UtilityNotificationSession`
Errors	NULL_ARGUMENT		`utilityReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsUtilityNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsUtilityNotification()` is `true.`
Method	getUtilityHierarchySession
Description	Gets the `OsidSession` associated with the utility hierarchy service.
Return	`osid.metering.UtilityHierarchySession`		a `UtilityHierarchySession` for utilities
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsUtilityHierarchy()` is `false`
Compliance	`optional`		This method must be implemented if `supportsUtilityHierarchy()` is `true.`
Method	getUtilityHierarchyDesignSession
Description	Gets the `OsidSession` associated with the utility hierarchy design service.
Return	`osid.metering.UtilityHierarchyDesignSession`		a `HierarchyDesignSession` for utilities
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsUtilityHierarchyDesign()` is `false`
Compliance	`optional`		This method must be implemented if `supportsUtilityHierarchyDesign()` is `true.`
Method	getMeteringBatchManager
Description	Gets a `MeteringBatchManager.`
Return	`osid.metering.batch.MeteringBatchManager`		a `MeteringBatchManager`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsMeteringBatch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsMeteringBatch()` is `true.`
Method	getMeteringThresholdManager
Description	Gets a `MeteringThresholdManager.`
Return	`osid.metering.threshold.MeteringThresholdManager`		a `MeteringThresholdManager`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsMeteringThreshold()` is `false`
Compliance	`optional`		This method must be implemented if `supportsMeteringThreshold()` is `true.`