org.osid.metering

Interface MeteringManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, MeteringProfile, OsidManager, OsidProfile, Sourceable

public interface MeteringManager
extends OsidManager, MeteringProfile

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 Summary

Methods

Modifier and Type	Method and Description
MeterAdminSession	getMeterAdminSession() Gets the OsidSession associated with the meter administrative service.
MeterAdminSession	getMeterAdminSessionForUtility(Id utilityId) Gets the OsidSession associated with the meter administrative service for the given utility.
MeteringBatchManager	getMeteringBatchManager() Gets a MeteringBatchManager.
MeteringThresholdManager	getMeteringThresholdManager() Gets a MeteringThresholdManager.
MeterLookupSession	getMeterLookupSession() Gets the OsidSession associated with the meter lookup service.
MeterLookupSession	getMeterLookupSessionForUtility(Id utilityId) Gets the OsidSession associated with the meter lookup service for the given utility.
MeterNotificationSession	getMeterNotificationSession(MeterReceiver meterReceiver) Gets the OsidSession associated with the meter notification service.
MeterNotificationSession	getMeterNotificationSessionForUtility(MeterReceiver meterReceiver, Id utilityId) Gets the OsidSession associated with the meter notification service for the given utility.
MeterQuerySession	getMeterQuerySession() Gets the OsidSession associated with the meter query service.
MeterQuerySession	getMeterQuerySessionForUtility(Id utilityId) Gets the OsidSession associated with the meter query service for the given utility.
MeterReadingSession	getMeterReadingSession() Gets the OsidSession associated with the meter reading service.
MeterReadingSession	getMeterReadingSessionForUtility(Id utilityId) Gets the OsidSession associated with the meter reading service for the given utility.
MeterSearchSession	getMeterSearchSession() Gets the OsidSession associated with the metering search service.
MeterSearchSession	getMeterSearchSessionForUtility(Id utilityId) Gets the OsidSession associated with the meter search service for the given utility.
MeterSmartUtilitySession	getMeterSmartUtilitySession(Id utilityId) Gets the OsidSession associated with the meter smart utility session.
MeterUtilityAssignmentSession	getMeterUtilityAssignmentSession() Gets the OsidSession associated with managing the mapping of meters and utilities.
MeterUtilitySession	getMeterUtilitySession() Gets the OsidSession associated with looking up mapping of meters and utilities.
StatisticLookupSession	getStatisticLookupSession() Gets the OsidSession associated with the statistic lookup service.
StatisticLookupSession	getStatisticLookupSessionForUtility(Id utilityId) Gets the OsidSession associated with the statistic lookup service for the given utility.
MeterNotificationSession	getStatisticNotificationSession(StatisticReceiver statisticReceiver) Gets the OsidSession associated with the statistic notification service.
MeterNotificationSession	getStatisticNotificationSessionForUtility(StatisticReceiver statisticReceiver, Id utilityId) Gets the OsidSession associated with the statistic notification service for the given utility.
StatisticQuerySession	getStatisticQuerySession() Gets the OsidSession associated with the statistic query service.
StatisticQuerySession	getStatisticQuerySessionForUtility(Id utilityId) Gets the OsidSession associated with the statistic query service for the given utility.
StatisticSearchSession	getStatisticSearchSession() Gets the OsidSession associated with the statistic search service.
StatisticSearchSession	getStatisticSearchSessionForUtility(Id utilityId) Gets the OsidSession associated with the statistic search service for the given utility.
StatisticSmartUtilitySession	getStatisticSmartUtilitySession(Id utilityId) Gets the OsidSession associated with the statistic smart utility session.
UtilityAdminSession	getUtilityAdminSession() Gets the OsidSession associated with the utility administrative service.
UtilityHierarchyDesignSession	getUtilityHierarchyDesignSession() Gets the OsidSession associated with the utility hierarchy design service.
UtilityHierarchySession	getUtilityHierarchySession() Gets the OsidSession associated with the utility hierarchy service.
UtilityLookupSession	getUtilityLookupSession() Gets the OsidSession associated with the utility lookup service.
UtilityNotificationSession	getUtilityNotificationSession(UtilityReceiver utilityReceiver) Gets the OsidSession associated with the utility notification service.
UtilityQuerySession	getUtilityQuerySession() Gets the OsidSession associated with the utility query service.
UtilitySearchSession	getUtilitySearchSession() Gets the OsidSession associated with the utility search service.

Methods inherited from interface org.osid.OsidManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.metering.MeteringProfile

getMeterRecordTypes, getMeterSearchRecordTypes, getStatisticRecordTypes, getStatisticSearchRecordTypes, getUtilityRecordTypes, getUtilitySearchRecordTypes, supportsMeteringBatch, supportsMeteringThreshold, supportsMeterLookup, supportsMeterNotification, supportsMeterQuery, supportsMeterReading, supportsMeterRecordType, supportsMeterSearch, supportsMeterSearchRecordType, supportsMeterUtility, supportsMeterUtilityAssignment, supportsSmartMeterUtility, supportsStatisticLookup, supportsStatisticNotification, supportsStatisticQuery, supportsStatisticRecordType, supportsStatisticSearch, supportsStatisticSearchRecordType, supportsStatisticSmartUtility, supportsUtilityAdmin, supportsUtilityHierarchy, supportsUtilityHierarchyDesign, supportsUtilityLookup, supportsUtilityNotification, supportsUtilityQuery, supportsUtilityRecordType, supportsUtilitySearch, supportsUtilitySearchRecordType, supportsVisibleFederation

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getMeterReadingSession

MeterReadingSession getMeterReadingSession()
                                           throws OperationFailedException

Gets the OsidSession associated with the meter reading service.

Returns:

a MeterReadingSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsMeterReading() is false

Compliance:

optional - This method must be implemented if supportsMeterReading() is true.

getMeterReadingSessionForUtility

MeterReadingSession getMeterReadingSessionForUtility(Id utilityId)
                                                     throws NotFoundException,
                                                            OperationFailedException

Gets the OsidSession associated with the meter reading service for the given utility.

Parameters:

utilityId - the Id of the Utility

Returns:

a MeterReadingSession

Throws:

NotFoundException - no Utility found by the given Id

NullArgumentException - utilityId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMeterReading() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsMeterReading() and supportsVisibleFederation() are true

getStatisticLookupSession

StatisticLookupSession getStatisticLookupSession()
                                                 throws OperationFailedException

Gets the OsidSession associated with the statistic lookup service.

Returns:

a StatisticLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsStatisticLookup() is false

Compliance:

optional - This method must be implemented if supportsStatisticLookup() is true.

getStatisticLookupSessionForUtility

StatisticLookupSession getStatisticLookupSessionForUtility(Id utilityId)
                                                           throws NotFoundException,
                                                                  OperationFailedException

Gets the OsidSession associated with the statistic lookup service for the given utility.

Parameters:

utilityId - the Id of the Utility

Returns:

a StatisticLookupSession

Throws:

NotFoundException - no Utility found by the given Id

NullArgumentException - utilityId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStatisticLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsStatisticLookup() and supportsVisibleFederation() are true

getStatisticQuerySession

StatisticQuerySession getStatisticQuerySession()
                                               throws OperationFailedException

Gets the OsidSession associated with the statistic query service.

Returns:

a StatisticQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsStatisticQuery() is false

Compliance:

optional - This method must be implemented if supportsStatisticQuery() is true.

getStatisticQuerySessionForUtility

StatisticQuerySession getStatisticQuerySessionForUtility(Id utilityId)
                                                         throws NotFoundException,
                                                                OperationFailedException

Gets the OsidSession associated with the statistic query service for the given utility.

Parameters:

utilityId - the Id of the Utility

Returns:

a StatisticQuerySession

Throws:

NotFoundException - no Utility found by the given Id

NullArgumentException - utilityId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStatisticQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsStatisticQuery() and supportsVisibleFederation() are true

getStatisticSearchSession

StatisticSearchSession getStatisticSearchSession()
                                                 throws OperationFailedException

Gets the OsidSession associated with the statistic search service.

Returns:

a StatisticSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsStatisticSearch() is false

Compliance:

optional - This method must be implemented if supportsStatisticSearch() is true.

getStatisticSearchSessionForUtility

StatisticSearchSession getStatisticSearchSessionForUtility(Id utilityId)
                                                           throws NotFoundException,
                                                                  OperationFailedException

Gets the OsidSession associated with the statistic search service for the given utility.

Parameters:

utilityId - the Id of the Utility

Returns:

a StatisticSearchSession

Throws:

NotFoundException - no Utility found by the given Id

NullArgumentException - utilityId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStatisticSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsStatisticSearch() and supportsVisibleFederation() are true

getStatisticNotificationSession

MeterNotificationSession getStatisticNotificationSession(StatisticReceiver statisticReceiver)
                                                         throws OperationFailedException

Gets the OsidSession associated with the statistic notification service.

Parameters:

statisticReceiver - the receiver

Returns:

a StatisticNotificationSession

Throws:

NullArgumentException - statisticReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStatisticNotification() is false

Compliance:

optional - This method must be implemented if supportsMeterNotification() is true.

getStatisticNotificationSessionForUtility

MeterNotificationSession getStatisticNotificationSessionForUtility(StatisticReceiver statisticReceiver,
                                                                 Id utilityId)
                                                                   throws NotFoundException,
                                                                          OperationFailedException

Gets the OsidSession associated with the statistic notification service for the given utility.

Parameters:

statisticReceiver - the receiver

utilityId - the Id of the Utility

Returns:

a StatisticNotificationSession

Throws:

NotFoundException - no Utility found by the given Id

NullArgumentException - statisticReceiver or utilityId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStatisticNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsStatisticNotification() and supportsVisibleFederation() are true

getStatisticSmartUtilitySession

StatisticSmartUtilitySession getStatisticSmartUtilitySession(Id utilityId)
                                                             throws NotFoundException,
                                                                    OperationFailedException

Gets the OsidSession associated with the statistic smart utility session.

Parameters:

utilityId - the Id of the Utility

Returns:

a StatisticSmartUtilitySession

Throws:

NotFoundException - no Utility found by the given Id

NullArgumentException - utilityId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStatisticSmartUtility() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsStatisticUtility() and supportsVisibleFederation() are true

getMeterLookupSession

MeterLookupSession getMeterLookupSession()
                                         throws OperationFailedException

Gets the OsidSession associated with the meter lookup service.

Returns:

a MeterLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsMeterLookup() is false

Compliance:

optional - This method must be implemented if supportsMeterLookup() is true.

getMeterLookupSessionForUtility

MeterLookupSession getMeterLookupSessionForUtility(Id utilityId)
                                                   throws NotFoundException,
                                                          OperationFailedException

Gets the OsidSession associated with the meter lookup service for the given utility.

Parameters:

utilityId - the Id of the Utility

Returns:

a MeterLookupSession

Throws:

NotFoundException - no Utility found by the given Id

NullArgumentException - utilityId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMeterLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsMeterLookup() and supportsVisibleFederation() are true

getMeterQuerySession

MeterQuerySession getMeterQuerySession()
                                       throws OperationFailedException

Gets the OsidSession associated with the meter query service.

Returns:

a MeterQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsMeterQuery() is false

Compliance:

optional - This method must be implemented if supportsMeterQuery() is true.

getMeterQuerySessionForUtility

MeterQuerySession getMeterQuerySessionForUtility(Id utilityId)
                                                 throws NotFoundException,
                                                        OperationFailedException

Gets the OsidSession associated with the meter query service for the given utility.

Parameters:

utilityId - the Id of the Utility

Returns:

a MeterQuerySession

Throws:

NotFoundException - no Utility found by the given Id

NullArgumentException - utilityId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMeterQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsMeterQuery() and supportsVisibleFederation() are true

getMeterSearchSession

MeterSearchSession getMeterSearchSession()
                                         throws OperationFailedException

Gets the OsidSession associated with the metering search service.

Returns:

a MeterSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsMeterSearch() is false

Compliance:

optional - This method must be implemented if supportsMeterSearch() is true.

getMeterSearchSessionForUtility

MeterSearchSession getMeterSearchSessionForUtility(Id utilityId)
                                                   throws NotFoundException,
                                                          OperationFailedException

Gets the OsidSession associated with the meter search service for the given utility.

Parameters:

utilityId - the Id of the Utility

Returns:

a MeterSearchSession

Throws:

NotFoundException - no Utility found by the given Id

NullArgumentException - utilityId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMeterSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsMeterSearch() and supportsVisibleFederation() are true

getMeterAdminSession

MeterAdminSession getMeterAdminSession()
                                       throws OperationFailedException

Gets the OsidSession associated with the meter administrative service.

Returns:

a MeterAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsMeterAdmin() is false

Compliance:

optional - This method must be implemented if supportsMeterAdmin() is true.

getMeterAdminSessionForUtility

MeterAdminSession getMeterAdminSessionForUtility(Id utilityId)
                                                 throws NotFoundException,
                                                        OperationFailedException

Gets the OsidSession associated with the meter administrative service for the given utility.

Parameters:

utilityId - the Id of the Utility

Returns:

a MeterAdminSession

Throws:

NotFoundException - no Utility found by the given Id

NullArgumentException - utilityId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMeterAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsMeterAdmin() and supportsVisibleFederation() are true

getMeterNotificationSession

MeterNotificationSession getMeterNotificationSession(MeterReceiver meterReceiver)
                                                     throws OperationFailedException

Gets the OsidSession associated with the meter notification service.

Parameters:

meterReceiver - the receiver

Returns:

a MeterNotificationSession

Throws:

NullArgumentException - meterReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMeterNotification() is false

Compliance:

optional - This method must be implemented if supportsMeterNotification() is true.

getMeterNotificationSessionForUtility

MeterNotificationSession getMeterNotificationSessionForUtility(MeterReceiver meterReceiver,
                                                             Id utilityId)
                                                               throws NotFoundException,
                                                                      OperationFailedException

Gets the OsidSession associated with the meter notification service for the given utility.

Parameters:

meterReceiver - the receiver

utilityId - the Id of the Utility

Returns:

a MeterNotificationSession

Throws:

NotFoundException - no Utility found by the given Id

NullArgumentException - meterReceiver or utilityId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMeterNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsMeterNotification() and supportsVisibleFederation() are true

getMeterUtilitySession

MeterUtilitySession getMeterUtilitySession()
                                           throws OperationFailedException

Gets the OsidSession associated with looking up mapping of meters and utilities.

Returns:

a MeterUtilitySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsMeterUtility() is false

Compliance:

optional - This method must be implemented if supportsMeterUtility() is true.

getMeterUtilityAssignmentSession

MeterUtilityAssignmentSession getMeterUtilityAssignmentSession()
                                                               throws OperationFailedException

Gets the OsidSession associated with managing the mapping of meters and utilities.

Returns:

a MeterUtilityAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsMeterUtilityAssignment() is false

Compliance:

optional - This method must be implemented if supportsMeterUtilityAssignment() is true.

getMeterSmartUtilitySession

MeterSmartUtilitySession getMeterSmartUtilitySession(Id utilityId)
                                                     throws NotFoundException,
                                                            OperationFailedException

Gets the OsidSession associated with the meter smart utility session.

Parameters:

utilityId - the Id of the Utility

Returns:

a MeterSmartUtilitySession

Throws:

NotFoundException - no Utility found by the given Id

NullArgumentException - utilityId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMeterSmartUtility() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsMeterUtility() and supportsVisibleFederation() are true

getUtilityLookupSession

UtilityLookupSession getUtilityLookupSession()
                                             throws OperationFailedException

Gets the OsidSession associated with the utility lookup service.

Returns:

a UtilityLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsUtilityLookup() is false

Compliance:

optional - This method must be implemented if supportsUtilityLookup() is true.

getUtilityQuerySession

UtilityQuerySession getUtilityQuerySession()
                                           throws OperationFailedException

Gets the OsidSession associated with the utility query service.

Returns:

a UtilityQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsUtilityQuery() is false

Compliance:

optional - This method must be implemented if supportsUtilityQuery() is true.

getUtilitySearchSession

UtilitySearchSession getUtilitySearchSession()
                                             throws OperationFailedException

Gets the OsidSession associated with the utility search service.

Returns:

a UtilitySearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsUtilitySearch() is false

Compliance:

optional - This method must be implemented if supportsUtilitySearch() is true.

getUtilityAdminSession

UtilityAdminSession getUtilityAdminSession()
                                           throws OperationFailedException

Gets the OsidSession associated with the utility administrative service.

Returns:

a UtilityAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsUtilityAdmin() is false

Compliance:

optional - This method must be implemented if supportsUtilityAdmin() is true.

getUtilityNotificationSession

UtilityNotificationSession getUtilityNotificationSession(UtilityReceiver utilityReceiver)
                                                         throws OperationFailedException

Gets the OsidSession associated with the utility notification service.

Parameters:

utilityReceiver - the receiver

Returns:

a UtilityNotificationSession

Throws:

NullArgumentException - utilityReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsUtilityNotification() is false

Compliance:

optional - This method must be implemented if supportsUtilityNotification() is true.

getUtilityHierarchySession

UtilityHierarchySession getUtilityHierarchySession()
                                                   throws OperationFailedException

Gets the OsidSession associated with the utility hierarchy service.

Returns:

a UtilityHierarchySession for utilities

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsUtilityHierarchy() is false

Compliance:

optional - This method must be implemented if supportsUtilityHierarchy() is true.

getUtilityHierarchyDesignSession

UtilityHierarchyDesignSession getUtilityHierarchyDesignSession()
                                                               throws OperationFailedException

Gets the OsidSession associated with the utility hierarchy design service.

Returns:

a HierarchyDesignSession for utilities

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsUtilityHierarchyDesign() is false

Compliance:

optional - This method must be implemented if supportsUtilityHierarchyDesign() is true.

getMeteringBatchManager

MeteringBatchManager getMeteringBatchManager()
                                             throws OperationFailedException

Gets a MeteringBatchManager.

Returns:

a MeteringBatchManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsMeteringBatch() is false

Compliance:

optional - This method must be implemented if supportsMeteringBatch() is true.

getMeteringThresholdManager

MeteringThresholdManager getMeteringThresholdManager()
                                                     throws OperationFailedException

Gets a MeteringThresholdManager.

Returns:

a MeteringThresholdManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsMeteringThreshold() is false

Compliance:

optional - This method must be implemented if supportsMeteringThreshold() is true.