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.
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. |
changeBranch, initialize, rollbackService
close
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
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
MeterReadingSession getMeterReadingSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the meter reading
service.proxy
- a proxy MeterReadingSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsMeterreading()
is false
optional
- This method must be implemented if
supportsMeterReading()
is true.
MeterReadingSession getMeterReadingSessionForUtility(Id utilityId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the meter reading
service for the given utility.utilityId
- the Id
of the Utility
proxy
- a proxy MeterReadingSession
NotFoundException
- no Utility
found by
the given Id
NullArgumentException
- utilityId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsMeterReading()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsMeterReading()
and
supportsVisibleFederation()
are true
StatisticLookupSession getStatisticLookupSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the statistic
lookup service.proxy
- a proxy MeterStatisticsSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStatisticLookup()
is false
optional
- This method must be implemented if
supportsStatisticLookup()
is true.
StatisticLookupSession getStatisticLookupSessionForUtility(Id utilityId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the statistic
lookup service for the given utility.utilityId
- the Id
of the Utility
proxy
- a proxy MeterStatisticsSession
NotFoundException
- no Utility
found by
the given Id
NullArgumentException
- utilityId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStatisticLookup()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsStatisticLookup()
and
supportsVisibleFederation()
are true
StatisticQuerySession getStatisticQuerySession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the statistic
query service.proxy
- a proxy StatisticQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStatisticQuery()
is false
optional
- This method must be implemented if
supportsStatisticQuery()
is true.
StatisticQuerySession getStatisticQuerySessionForUtility(Id utilityId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the statistic
query service for the given utility.utilityId
- the Id
of the Utility
proxy
- a proxy StatisticQuerySession
NotFoundException
- no Utility
found by
the given Id
NullArgumentException
- utilityId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStatisticQuery()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsStatisticQuery()
and
supportsVisibleFederation()
are true
StatisticSearchSession getStatisticSearchSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the statistic
search service.proxy
- a proxy StatisticSearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStatisticSearch()
is false
optional
- This method must be implemented if
supportsStatisticSearch()
is true.
StatisticSearchSession getStatisticSearchSessionForUtility(Id utilityId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the statistic
search service for the given utility.utilityId
- the Id
of the Utility
proxy
- a proxy StatisticSearchSession
NotFoundException
- no Utility
found by
the given Id
NullArgumentException
- utilityId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStatisticSearch()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsStatisticSearch()
and
supportsVisibleFederation()
are true
StatisticNotificationSession getStatisticNotificationSession(StatisticReceiver statisticReceiver, Proxy proxy) throws OperationFailedException
OsidSession
associated with the statistic
notification service.statisticReceiver
- the receiverproxy
- a proxy StatisticNotificationSession
NullArgumentException
- statisticReceiver
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStatisticNotification()
is false
optional
- This method must be implemented if
supportsStatisticNotification()
is true.
StatisticNotificationSession getStatisticNotificationSessionForUtility(StatisticReceiver statisticReceiver, Id utilityId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the statistic
notification service for the given utility.statisticReceiver
- the receiverutilityId
- the Id
of the Utility
proxy
- a proxy StatisticNotificationSession
NotFoundException
- no Utility
found by
the given Id
NullArgumentException
- statisticReceiver,
utilityId
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStatisticNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsStatisticNotification()
and
supportsVisibleFederation()
are true
StatisticSmartUtilitySession getStatisticSmartUtilitySession(Id utilityId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the statistic
smart utility session.utilityId
- the Id
of the Utility
proxy
- a proxy StatisticSmartUtilitySession
NotFoundException
- no Utility
found by
the given Id
NullArgumentException
- utilityId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsStatisticSmartUtility()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsStatisticSmartUtility()
and
supportsVisibleFederation()
are true
MeterLookupSession getMeterLookupSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the meter lookup
service.proxy
- a proxy MeterLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsMeterLookup()
is false
optional
- This method must be implemented if
supportsMeterLookup()
is true.
MeterLookupSession getMeterLookupSessionForUtility(Id utilityId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the utility
reading service for the given utility.utilityId
- the Id
of the Utility
proxy
- a proxy MeterLookupSession
NotFoundException
- no Utility
found by
the given Id
NullArgumentException
- utilityId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsMeterLookup()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsMeterLookup()
and
supportsVisibleFederation()
are true
MeterQuerySession getMeterQuerySession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the meter query
service.proxy
- a proxy MeterQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsMeterQuery()
is false
optional
- This method must be implemented if
supportsMeterQuery()
is true.
MeterQuerySession getMeterQuerySessionForUtility(Id utilityId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the utility query
service for the given utility.utilityId
- the Id
of the Utility
proxy
- a proxy MeterQuerySession
NotFoundException
- no Utility
found by
the given Id
NullArgumentException
- utilityId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsMeterQuery()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsMeterQuery()
and
supportsVisibleFederation()
are true
MeterSearchSession getMeterSearchSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the meter search
service.proxy
- a proxy MeterSearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsMeterSearch()
is false
optional
- This method must be implemented if
supportsMeterSearch()
is true.
MeterSearchSession getMeterSearchSessionForUtility(Id utilityId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the meter search
service for the given utility.utilityId
- the Id
of the Utility
proxy
- a proxy MeterSearchSession
NotFoundException
- no Utility
found by
the given Id
NullArgumentException
- utilityId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsMeterSearch()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsMeterSearch()
and
supportsVisibleFederation()
are true
MeterAdminSession getMeterAdminSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the meter
administrative service.proxy
- a proxy MeterAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsMeterAdmin()
is false
optional
- This method must be implemented if
supportsMeterAdmin()
is true.
MeterAdminSession getMeterAdminSessionForUtility(Id utilityId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the meter
administrative service for the given utility.utilityId
- the Id
of the Utility
proxy
- a proxy MeterAdminSession
NotFoundException
- no Utility
found by
the given Id
NullArgumentException
- utilityId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsMeterAdmin()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsMeterAdmin()
and
supportsVisibleFederation()
are true
MeterNotificationSession getMeterNotificationSession(MeterReceiver meterReceiver, Proxy proxy) throws OperationFailedException
OsidSession
associated with the meter
notification service.meterReceiver
- the receiverproxy
- a proxy MeterNotificationSession
NullArgumentException
- meterReceiver
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsMeterNotification()
is false
optional
- This method must be implemented if
supportsMeterNotification()
is true.
MeterNotificationSession getMeterNotificationSessionForUtility(MeterReceiver meterReceiver, Id utilityId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the meter
notification service for the given utility.meterReceiver
- the receiverutilityId
- the Id
of the Utility
proxy
- a proxy MeterNotificationSession
NotFoundException
- no Utility
found by
the given Id
NullArgumentException
- meterReceiver, utilityId
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsMeterNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsMeterNotification()
and
supportsVisibleFederation()
are true
MeterUtilitySession getMeterUtilitySession(Proxy proxy) throws OperationFailedException
OsidSession
associated with looking up mapping
of meters and utilities.proxy
- a proxy MeterUtilitySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsMeterUtility()
is false
optional
- This method must be implemented if
supportsMeterUtility()
is true.
MeterUtilityAssignmentSession getMeterUtilityAssignmentSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with managing the
mapping of meters and utilities.proxy
- a proxy MeterUtilityAssignmentSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsMeterUtilityAssignment()
is false
optional
- This method must be implemented if
supportsMeterUtilityAssignment()
is true.
MeterSmartUtilitySession getMeterSmartUtilitySession(Id utilityId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the meter smart
utility session.utilityId
- the Id
of the Utility
proxy
- a proxy MeterSmartUtilitySession
NotFoundException
- no Utility
found by
the given Id
NullArgumentException
- utilityId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsMeterSmartUtility()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsMeterSmartUtility()
and
supportsVisibleFederation()
are true
UtilityLookupSession getUtilityLookupSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the utility lookup
service.proxy
- a proxy UtilityLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsUtilityLookup()
is false
optional
- This method must be implemented if
supportsUtilityLookup()
is true.
UtilityQuerySession getUtilityQuerySession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the utility query
service.proxy
- a proxy UtilityQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsUtilityQuery()
is false
optional
- This method must be implemented if
supportsUtilityQuery()
is true.
UtilitySearchSession getUtilitySearchSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the utility search
service.proxy
- a proxy UtilitySearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsUtilitySearch()
is false
optional
- This method must be implemented if
supportsUtilitySearch()
is true.
UtilityAdminSession getUtilityAdminSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the utility
administrative service.proxy
- a proxy UtilityAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsUtilityAdmin()
is false
optional
- This method must be implemented if
supportsUtilityAdmin()
is true.
UtilityNotificationSession getUtilityNotificationSession(UtilityReceiver utilityReceiver, Proxy proxy) throws OperationFailedException
OsidSession
associated with the utility
notification service.utilityReceiver
- the receiverproxy
- a proxy UtilityNotificationSession
NullArgumentException
- utilityReceiver
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsUtilityNotification()
is false
optional
- This method must be implemented if
supportsUtilityNotification()
is true.
UtilityHierarchySession getUtilityHierarchySession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the utility
hierarchy service.proxy
- a proxy UtilityHierarchySession
for utilitiesNullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsUtilityHierarchy()
is false
optional
- This method must be implemented if
supportsUtilityHierarchy()
is true.
UtilityHierarchyDesignSession getUtilityHierarchyDesignSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the utility
hierarchy design service.proxy
- a proxy HierarchyDesignSession
for utilitiesNullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsUtilityHierarchyDesign()
is false
optional
- This method must be implemented if
supportsUtilityHierarchyDesign()
is true.
MeteringBatchProxyManager getMeteringBatchProxyManager() throws OperationFailedException
MeteringBatchProxyManager.
MeteringBatchProxyManager
OperationFailedException
- unable to complete requestUnimplementedException
- supportsMeteringBatch()
is false
optional
- This method must be implemented if
supportsMeteringBatch()
is true.
MeteringThresholdProxyManager getMeteringThresholdProxyManager() throws OperationFailedException
MeteringThresholdProxyManager.
MeteringThresholdProxyManager
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsMeteringThreshold()
is false
optional
- This method must be implemented if
supportsMeteringThreshold()
is true.