org.osid.metering

Interface MeteringProxyManager

All Superinterfaces:

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

public interface MeteringProxyManager
extends OsidProxyManager, MeteringProfile

The metering manager provides access to metering sessions and provides interoperability tests for various aspects of this service. Methods in this manager support the passing of a Proxy for the purposes of passing information from a server environment. 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(Proxy proxy) Gets the OsidSession associated with the meter administrative service.
MeterAdminSession	getMeterAdminSessionForUtility(Id utilityId, Proxy proxy) Gets the OsidSession associated with the meter administrative service for the given utility.
MeteringBatchProxyManager	getMeteringBatchProxyManager() Gets a MeteringBatchProxyManager.
MeteringThresholdProxyManager	getMeteringThresholdProxyManager() Gets a MeteringThresholdProxyManager.
MeterLookupSession	getMeterLookupSession(Proxy proxy) Gets the OsidSession associated with the meter lookup service.
MeterLookupSession	getMeterLookupSessionForUtility(Id utilityId, Proxy proxy) Gets the OsidSession associated with the utility reading service for the given utility.
MeterNotificationSession	getMeterNotificationSession(MeterReceiver meterReceiver, Proxy proxy) Gets the OsidSession associated with the meter notification service.
MeterNotificationSession	getMeterNotificationSessionForUtility(MeterReceiver meterReceiver, Id utilityId, Proxy proxy) Gets the OsidSession associated with the meter notification service for the given utility.
MeterQuerySession	getMeterQuerySession(Proxy proxy) Gets the OsidSession associated with the meter query service.
MeterQuerySession	getMeterQuerySessionForUtility(Id utilityId, Proxy proxy) Gets the OsidSession associated with the utility query service for the given utility.
MeterReadingSession	getMeterReadingSession(Proxy proxy) Gets the OsidSession associated with the meter reading service.
MeterReadingSession	getMeterReadingSessionForUtility(Id utilityId, Proxy proxy) Gets the OsidSession associated with the meter reading service for the given utility.
MeterSearchSession	getMeterSearchSession(Proxy proxy) Gets the OsidSession associated with the meter search service.
MeterSearchSession	getMeterSearchSessionForUtility(Id utilityId, Proxy proxy) Gets the OsidSession associated with the meter search service for the given utility.
MeterSmartUtilitySession	getMeterSmartUtilitySession(Id utilityId, Proxy proxy) Gets the OsidSession associated with the meter smart utility session.
MeterUtilityAssignmentSession	getMeterUtilityAssignmentSession(Proxy proxy) Gets the OsidSession associated with managing the mapping of meters and utilities.
MeterUtilitySession	getMeterUtilitySession(Proxy proxy) Gets the OsidSession associated with looking up mapping of meters and utilities.
StatisticLookupSession	getStatisticLookupSession(Proxy proxy) Gets the OsidSession associated with the statistic lookup service.
StatisticLookupSession	getStatisticLookupSessionForUtility(Id utilityId, Proxy proxy) Gets the OsidSession associated with the statistic lookup service for the given utility.
StatisticNotificationSession	getStatisticNotificationSession(StatisticReceiver statisticReceiver, Proxy proxy) Gets the OsidSession associated with the statistic notification service.
StatisticNotificationSession	getStatisticNotificationSessionForUtility(StatisticReceiver statisticReceiver, Id utilityId, Proxy proxy) Gets the OsidSession associated with the statistic notification service for the given utility.
StatisticQuerySession	getStatisticQuerySession(Proxy proxy) Gets the OsidSession associated with the statistic query service.
StatisticQuerySession	getStatisticQuerySessionForUtility(Id utilityId, Proxy proxy) Gets the OsidSession associated with the statistic query service for the given utility.
StatisticSearchSession	getStatisticSearchSession(Proxy proxy) Gets the OsidSession associated with the statistic search service.
StatisticSearchSession	getStatisticSearchSessionForUtility(Id utilityId, Proxy proxy) Gets the OsidSession associated with the statistic search service for the given utility.
StatisticSmartUtilitySession	getStatisticSmartUtilitySession(Id utilityId, Proxy proxy) Gets the OsidSession associated with the statistic smart utility session.
UtilityAdminSession	getUtilityAdminSession(Proxy proxy) Gets the OsidSession associated with the utility administrative service.
UtilityHierarchyDesignSession	getUtilityHierarchyDesignSession(Proxy proxy) Gets the OsidSession associated with the utility hierarchy design service.
UtilityHierarchySession	getUtilityHierarchySession(Proxy proxy) Gets the OsidSession associated with the utility hierarchy service.
UtilityLookupSession	getUtilityLookupSession(Proxy proxy) Gets the OsidSession associated with the utility lookup service.
UtilityNotificationSession	getUtilityNotificationSession(UtilityReceiver utilityReceiver, Proxy proxy) Gets the OsidSession associated with the utility notification service.
UtilityQuerySession	getUtilityQuerySession(Proxy proxy) Gets the OsidSession associated with the utility query service.
UtilitySearchSession	getUtilitySearchSession(Proxy proxy) Gets the OsidSession associated with the utility search service.

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

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

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(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession associated with the meter reading service.

Parameters:

proxy - a proxy

Returns:

a MeterReadingSession

Throws:

NullArgumentException - proxy is null

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,
                                                   Proxy proxy)
                                                     throws NotFoundException,
                                                            OperationFailedException

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

Parameters:

utilityId - the Id of the Utility

proxy - a proxy

Returns:

a MeterReadingSession

Throws:

NotFoundException - no Utility found by the given Id

NullArgumentException - utilityId or proxy 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(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession associated with the statistic lookup service.

Parameters:

proxy - a proxy

Returns:

a MeterStatisticsSession

Throws:

NullArgumentException - proxy is null

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,
                                                         Proxy proxy)
                                                           throws NotFoundException,
                                                                  OperationFailedException

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

Parameters:

utilityId - the Id of the Utility

proxy - a proxy

Returns:

a MeterStatisticsSession

Throws:

NotFoundException - no Utility found by the given Id

NullArgumentException - utilityId or proxy 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(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession associated with the statistic query service.

Parameters:

proxy - a proxy

Returns:

a StatisticQuerySession

Throws:

NullArgumentException - proxy is null

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,
                                                       Proxy proxy)
                                                         throws NotFoundException,
                                                                OperationFailedException

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

Parameters:

utilityId - the Id of the Utility

proxy - a proxy

Returns:

a StatisticQuerySession

Throws:

NotFoundException - no Utility found by the given Id

NullArgumentException - utilityId or proxy 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(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession associated with the statistic search service.

Parameters:

proxy - a proxy

Returns:

a StatisticSearchSession

Throws:

NullArgumentException - proxy is null

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,
                                                         Proxy proxy)
                                                           throws NotFoundException,
                                                                  OperationFailedException

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

Parameters:

utilityId - the Id of the Utility

proxy - a proxy

Returns:

a StatisticSearchSession

Throws:

NotFoundException - no Utility found by the given Id

NullArgumentException - utilityId or proxy 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

StatisticNotificationSession getStatisticNotificationSession(StatisticReceiver statisticReceiver,
                                                           Proxy proxy)
                                                             throws OperationFailedException

Gets the OsidSession associated with the statistic notification service.

Parameters:

statisticReceiver - the receiver

proxy - a proxy

Returns:

a StatisticNotificationSession

Throws:

NullArgumentException - statisticReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStatisticNotification() is false

Compliance:

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

getStatisticNotificationSessionForUtility

StatisticNotificationSession getStatisticNotificationSessionForUtility(StatisticReceiver statisticReceiver,
                                                                     Id utilityId,
                                                                     Proxy proxy)
                                                                       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

proxy - a proxy

Returns:

a StatisticNotificationSession

Throws:

NotFoundException - no Utility found by the given Id

NullArgumentException - statisticReceiver, utilityId or proxy 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,
                                                           Proxy proxy)
                                                             throws NotFoundException,
                                                                    OperationFailedException

Gets the OsidSession associated with the statistic smart utility session.

Parameters:

utilityId - the Id of the Utility

proxy - a proxy

Returns:

a StatisticSmartUtilitySession

Throws:

NotFoundException - no Utility found by the given Id

NullArgumentException - utilityId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStatisticSmartUtility() or supportsVisibleFederation() is false

Compliance:

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

getMeterLookupSession

MeterLookupSession getMeterLookupSession(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the meter lookup service.

Parameters:

proxy - a proxy

Returns:

a MeterLookupSession

Throws:

NullArgumentException - proxy is null

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,
                                                 Proxy proxy)
                                                   throws NotFoundException,
                                                          OperationFailedException

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

Parameters:

utilityId - the Id of the Utility

proxy - a proxy

Returns:

a MeterLookupSession

Throws:

NotFoundException - no Utility found by the given Id

NullArgumentException - utilityId or proxy 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(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the meter query service.

Parameters:

proxy - a proxy

Returns:

a MeterQuerySession

Throws:

NullArgumentException - proxy is null

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,
                                               Proxy proxy)
                                                 throws NotFoundException,
                                                        OperationFailedException

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

Parameters:

utilityId - the Id of the Utility

proxy - a proxy

Returns:

a MeterQuerySession

Throws:

NotFoundException - no Utility found by the given Id

NullArgumentException - utilityId or proxy 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(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the meter search service.

Parameters:

proxy - a proxy

Returns:

a MeterSearchSession

Throws:

NullArgumentException - proxy is null

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,
                                                 Proxy proxy)
                                                   throws NotFoundException,
                                                          OperationFailedException

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

Parameters:

utilityId - the Id of the Utility

proxy - a proxy

Returns:

a MeterSearchSession

Throws:

NotFoundException - no Utility found by the given Id

NullArgumentException - utilityId or proxy 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(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the meter administrative service.

Parameters:

proxy - a proxy

Returns:

a MeterAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                               Proxy proxy)
                                                 throws NotFoundException,
                                                        OperationFailedException

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

Parameters:

utilityId - the Id of the Utility

proxy - a proxy

Returns:

a MeterAdminSession

Throws:

NotFoundException - no Utility found by the given Id

NullArgumentException - utilityId or proxy 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,
                                                   Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the meter notification service.

Parameters:

meterReceiver - the receiver

proxy - a proxy

Returns:

a MeterNotificationSession

Throws:

NullArgumentException - meterReceiver or proxy 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,
                                                             Proxy proxy)
                                                               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

proxy - a proxy

Returns:

a MeterNotificationSession

Throws:

NotFoundException - no Utility found by the given Id

NullArgumentException - meterReceiver, utilityId or proxy 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(Proxy proxy)
                                           throws OperationFailedException

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

Parameters:

proxy - a proxy

Returns:

a MeterUtilitySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMeterUtility() is false

Compliance:

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

getMeterUtilityAssignmentSession

MeterUtilityAssignmentSession getMeterUtilityAssignmentSession(Proxy proxy)
                                                               throws OperationFailedException

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

Parameters:

proxy - a proxy

Returns:

a MeterUtilityAssignmentSession

Throws:

NullArgumentException - proxy is null

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,
                                                   Proxy proxy)
                                                     throws NotFoundException,
                                                            OperationFailedException

Gets the OsidSession associated with the meter smart utility session.

Parameters:

utilityId - the Id of the Utility

proxy - a proxy

Returns:

a MeterSmartUtilitySession

Throws:

NotFoundException - no Utility found by the given Id

NullArgumentException - utilityId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMeterSmartUtility() or supportsVisibleFederation() is false

Compliance:

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

getUtilityLookupSession

UtilityLookupSession getUtilityLookupSession(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the utility lookup service.

Parameters:

proxy - a proxy

Returns:

a UtilityLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsUtilityLookup() is false

Compliance:

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

getUtilityQuerySession

UtilityQuerySession getUtilityQuerySession(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession associated with the utility query service.

Parameters:

proxy - a proxy

Returns:

a UtilityQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsUtilityQuery() is false

Compliance:

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

getUtilitySearchSession

UtilitySearchSession getUtilitySearchSession(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the utility search service.

Parameters:

proxy - a proxy

Returns:

a UtilitySearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsUtilitySearch() is false

Compliance:

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

getUtilityAdminSession

UtilityAdminSession getUtilityAdminSession(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession associated with the utility administrative service.

Parameters:

proxy - a proxy

Returns:

a UtilityAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                       Proxy proxy)
                                                         throws OperationFailedException

Gets the OsidSession associated with the utility notification service.

Parameters:

utilityReceiver - the receiver

proxy - a proxy

Returns:

a UtilityNotificationSession

Throws:

NullArgumentException - utilityReceiver or proxy 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(Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession associated with the utility hierarchy service.

Parameters:

proxy - a proxy

Returns:

a UtilityHierarchySession for utilities

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsUtilityHierarchy() is false

Compliance:

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

getUtilityHierarchyDesignSession

UtilityHierarchyDesignSession getUtilityHierarchyDesignSession(Proxy proxy)
                                                               throws OperationFailedException

Gets the OsidSession associated with the utility hierarchy design service.

Parameters:

proxy - a proxy

Returns:

a HierarchyDesignSession for utilities

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsUtilityHierarchyDesign() is false

Compliance:

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

getMeteringBatchProxyManager

MeteringBatchProxyManager getMeteringBatchProxyManager()
                                                       throws OperationFailedException

Gets a MeteringBatchProxyManager.

Returns:

a MeteringBatchProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsMeteringBatch() is false

Compliance:

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

getMeteringThresholdProxyManager

MeteringThresholdProxyManager getMeteringThresholdProxyManager()
                                                               throws OperationFailedException

Gets a MeteringThresholdProxyManager.

Returns:

a MeteringThresholdProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsMeteringThreshold() is false

Compliance:

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