Interface MeteringManager

All Superinterfaces:

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

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

close

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

Methods inherited from interface OsidManager

changeBranch, initialize, rollbackService

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

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