public interface MeteringBatchProxyManager extends OsidProxyManager, MeteringBatchProfile
The metering batch proxy manager provides access to metering batch
sessions and provides interoperability tests for various aspects of this
service. Methods in this manager support the passing of a Proxy
object. The sessions included in this manager are:
MeterBatchAdminSession:
a session to create,
modify and delete meters in bulk UtilityBatchAdminSession:
a session to create,
modify and delete utilities in bulk Modifier and Type | Method and Description |
---|---|
MeterBatchAdminSession |
getMeterBatchAdminSession(Proxy proxy)
Gets the
OsidSession associated with the bulk meter
administration service. |
MeterBatchAdminSession |
getMeterBatchAdminSessionForUtility(Id utilityId,
Proxy proxy)
Gets the
OsidSession associated with the bulk meter
administration service for the given utility. |
UtilityBatchAdminSession |
getUtilityBatchAdminSession(Proxy proxy)
Gets the
OsidSession associated with the bulk utility
administration service. |
changeBranch, initialize, rollbackService
close
supportsMeterBatchAdmin, supportsUtilityBatchAdmin, supportsVisibleFederation
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
MeterBatchAdminSession getMeterBatchAdminSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the bulk meter
administration service.proxy
- a proxy MeterBatchAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsMeterBatchAdmin()
is false
optional
- This method must be implemented if
supportsMeterBatchAdmin()
is true.
MeterBatchAdminSession getMeterBatchAdminSessionForUtility(Id utilityId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk meter
administration service for the given utility.utilityId
- the Id
of the Utility
proxy
- a proxy MeterBatchAdminSession
NotFoundException
- no Utility
found by
the given Id
NullArgumentException
- utilityId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsMeterBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsMeterBatchAdmin()
and
supportsVisibleFederation()
are true
UtilityBatchAdminSession getUtilityBatchAdminSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the bulk utility
administration service.proxy
- a proxy UtilityBatchAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsUtilityBatchAdmin()
is false
optional
- This method must be implemented if
supportsUtilityBatchAdmin()
is true.