OSID Logo
OSID Specifications
metering batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.metering.batch.MeteringBatchProxyManager
Implementsosid.OsidProxyManager
osid.metering.batch.MeteringBatchProfile
Description

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
MethodgetMeterBatchAdminSession
Description

Gets the OsidSession associated with the bulk meter administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.metering.batch.MeterBatchAdminSessiona MeterBatchAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsMeterBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsMeterBatchAdmin() is true.
MethodgetMeterBatchAdminSessionForUtility
Description

Gets the OsidSession associated with the bulk meter administration service for the given utility.

Parametersosid.id.IdutilityIdthe Id of the Utility
osid.proxy.Proxyproxya proxy
Returnosid.metering.batch.MeterBatchAdminSessiona MeterBatchAdminSession
ErrorsNOT_FOUNDno Utility found by the given Id
NULL_ARGUMENT utilityId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsMeterBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsMeterBatchAdmin() and supportsVisibleFederation() are true
MethodgetUtilityBatchAdminSession
Description

Gets the OsidSession associated with the bulk utility administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.metering.batch.UtilityBatchAdminSessiona UtilityBatchAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsUtilityBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsUtilityBatchAdmin() is true.