Interface MeteringProxyManager

All Superinterfaces:

AutoCloseable, Closeable, MeteringProfile, OsidProfile, OsidProxyManager, 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

Modifier and Type	Method	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 Closeable

close

Methods inherited from interface 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

Modifier and Type	Method	Description
TypeList	getMeterRecordTypes()	Gets the supported Meter record types.
TypeList	getMeterSearchRecordTypes()	Gets the supported meter search record types.
TypeList	getStatisticRecordTypes()	Gets the supported Statistic record types.
TypeList	getStatisticSearchRecordTypes()	Gets the supported statistic search record types.
TypeList	getUtilityRecordTypes()	Gets the supported Utility record types.
TypeList	getUtilitySearchRecordTypes()	Gets the supported utility search record types.
boolean	supportsMeteringBatch()	Tests for the availability of a metering batch service.
boolean	supportsMeteringThreshold()	Tests for the availability of a metering threshold service.
boolean	supportsMeterLookup()	Tests if looking up meters is supported.
boolean	supportsMeterNotification()	Tests if meter notification is supported,.
boolean	supportsMeterQuery()	Tests if querying meters is supported.
boolean	supportsMeterReading()	Tests if reading meters is supported.
boolean	supportsMeterRecordType(Type meterRecordType)	Tests if the given Meter record type is supported.
boolean	supportsMeterSearch()	Tests if searching meters is supported.
boolean	supportsMeterSearchRecordType(Type meterSearchRecordType)	Tests if the given meter search record type is supported.
boolean	supportsMeterUtility()	Tests if looking up meter utlity mappings is supported,.
boolean	supportsMeterUtilityAssignment()	Tests if managing meter utlity mappings is supported,.
boolean	supportsSmartMeterUtility()	Tests if managing meter smart utlity service is supported,.
boolean	supportsStatisticLookup()	Tests if statistical lookup is supported.
boolean	supportsStatisticNotification()	Tests if statistical notification is supported.
boolean	supportsStatisticQuery()	Tests if statistical query is supported.
boolean	supportsStatisticRecordType(Type statisticRecordType)	Tests if the given Statistic record type is supported.
boolean	supportsStatisticSearch()	Tests if statistical search is supported.
boolean	supportsStatisticSearchRecordType(Type statisticSearchRecordType)	Tests if the given statistic search record type is supported.
boolean	supportsStatisticSmartUtility()	Tests if statistical smart utilitiy is supported.
boolean	supportsUtilityAdmin()	Tests for the availability of a utility administrative service for creating and deleting utilities.
boolean	supportsUtilityHierarchy()	Tests for the availability of a utility hierarchy traversal service.
boolean	supportsUtilityHierarchyDesign()	Tests for the availability of a utility hierarchy design service.
boolean	supportsUtilityLookup()	Tests for the availability of a utility lookup service.
boolean	supportsUtilityNotification()	Tests for the availability of a utility notification service.
boolean	supportsUtilityQuery()	Tests for the availability of a utility query service.
boolean	supportsUtilityRecordType(Type utilityRecordType)	Tests if the given Utility record type is supported.
boolean	supportsUtilitySearch()	Tests if searching for utilities is available.
boolean	supportsUtilitySearchRecordType(Type utilitySearchRecordType)	Tests if the given utility search record type is supported.
boolean	supportsVisibleFederation()	Tests if visible federation is supported.

Methods inherited from interface OsidProfile

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

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface OsidProxyManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidProxyManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId, Proxy proxy)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime, Proxy proxy)	Rolls back this service to a point in time.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

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 {@code supportsMeterReading()} is {@code 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 {@code supportsMeterReading()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsStatisticLookup()} is {@code 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 {@code supportsStatisticLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsStatisticQuery()} is {@code 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 {@code supportsStatisticQuery()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsStatisticSearch()} is {@code 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 {@code supportsStatisticSearch()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsStatisticNotification()} is {@code 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 {@code supportsStatisticNotification()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsStatisticSmartUtility()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsMeterLookup()} is {@code 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 {@code supportsMeterLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsMeterQuery()} is {@code 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 {@code supportsMeterQuery()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsMeterSearch()} is {@code 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 {@code supportsMeterSearch()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsMeterAdmin()} is {@code 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 {@code supportsMeterAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsMeterNotification()} is {@code 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 {@code supportsMeterNotification()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsMeterUtility()} is {@code 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 {@code supportsMeterUtilityAssignment()} is {@code 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 {@code supportsMeterSmartUtility()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsUtilityLookup()} is {@code 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 {@code supportsUtilityQuery()} is {@code 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 {@code supportsUtilitySearch()} is {@code 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 {@code supportsUtilityAdmin()} is {@code 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 {@code supportsUtilityNotification()} is {@code 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 {@code supportsUtilityHierarchy()} is {@code 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 {@code supportsUtilityHierarchyDesign()} is {@code 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 {@code supportsMeteringBatch()} is {@code 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 {@code supportsMeteringThreshold()} is {@code true} .