org.osid.metering.batch

Interface MeteringBatchProxyManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, MeteringBatchProfile, OsidProfile, OsidProxyManager, Sourceable

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

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidProxyManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.metering.batch.MeteringBatchProfile

supportsMeterBatchAdmin, supportsUtilityBatchAdmin, supportsVisibleFederation

Methods inherited from interface org.osid.OsidProfile

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

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getMeterBatchAdminSession

MeterBatchAdminSession getMeterBatchAdminSession(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession associated with the bulk meter administration service.

Parameters:

proxy - a proxy

Returns:

a MeterBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMeterBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsMeterBatchAdmin() is true.

getMeterBatchAdminSessionForUtility

MeterBatchAdminSession getMeterBatchAdminSessionForUtility(Id utilityId,
                                                         Proxy proxy)
                                                           throws NotFoundException,
                                                                  OperationFailedException

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

Parameters:

utilityId - the Id of the Utility

proxy - a proxy

Returns:

a MeterBatchAdminSession

Throws:

NotFoundException - no Utility found by the given Id

NullArgumentException - utilityId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMeterBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsMeterBatchAdmin() and supportsVisibleFederation() are true

getUtilityBatchAdminSession

UtilityBatchAdminSession getUtilityBatchAdminSession(Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the bulk utility administration service.

Parameters:

proxy - a proxy

Returns:

a UtilityBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsUtilityBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsUtilityBatchAdmin() is true.