OSID Logo
OSID Specifications
metering package
Version 3.0.0
Release Candidate Preview
Interfaceosid.metering.MeteringProfile
Implementsosid.OsidProfile
Description

The metering profile describes the interoperability among metering services.

MethodsupportsVisibleFederation
Description

Tests if visible federation is supported.

Returnboolean true if visible federation is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsMeterReading
Description

Tests if reading meters is supported.

Returnboolean true if reading meters is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsStatisticLookup
Description

Tests if statistical lookup is supported.

Returnboolean true if statistical lookup is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsStatisticQuery
Description

Tests if statistical query is supported.

Returnboolean true if statistical query is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsStatisticSearch
Description

Tests if statistical search is supported.

Returnboolean true if statistical search is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsStatisticNotification
Description

Tests if statistical notification is supported.

Returnboolean true if statistical notification is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsStatisticSmartUtility
Description

Tests if statistical smart utilitiy is supported.

Returnboolean true if statistical smart utility is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsMeterLookup
Description

Tests if looking up meters is supported.

Returnboolean true if looking up meters is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsMeterQuery
Description

Tests if querying meters is supported.

Returnboolean true if querying meters is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsMeterSearch
Description

Tests if searching meters is supported.

Returnboolean true if searching meters is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsMeterNotification
Description

Tests if meter notification is supported,.

Returnboolean true if meter notification is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsMeterUtility
Description

Tests if looking up meter utlity mappings is supported,.

Returnboolean true if utility meter mapping is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsMeterUtilityAssignment
Description

Tests if managing meter utlity mappings is supported,.

Returnboolean true if assigning utility meter mappings is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsSmartMeterUtility
Description

Tests if managing meter smart utlity service is supported,.

Returnboolean true if a meter smart utility service is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsUtilityLookup
Description

Tests for the availability of a utility lookup service.

Returnboolean true if utility lookup is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsUtilityQuery
Description

Tests for the availability of a utility query service.

Returnboolean true if utility query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsUtilitySearch
Description

Tests if searching for utilities is available.

Returnboolean true if utility search is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsUtilityAdmin
Description

Tests for the availability of a utility administrative service for creating and deleting utilities.

Returnboolean true if utility administration is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsUtilityNotification
Description

Tests for the availability of a utility notification service.

Returnboolean true if utility notification is available, false otherwise
CompliancemandatoryThis method must be implemented in all providers.
MethodsupportsUtilityHierarchy
Description

Tests for the availability of a utility hierarchy traversal service.

Returnboolean true if utility hierarchy traversal is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsUtilityHierarchyDesign
Description

Tests for the availability of a utility hierarchy design service.

Returnboolean true if utility hierarchy design is available, false otherwise
CompliancemandatoryThis method must be implemented in all providers.
MethodsupportsMeteringBatch
Description

Tests for the availability of a metering batch service.

Returnboolean true if metering batch service is available, false otherwise
CompliancemandatoryThis method must be implemented in all providers.
MethodsupportsMeteringThreshold
Description

Tests for the availability of a metering threshold service.

Returnboolean true if metering threshold service is available, false otherwise
CompliancemandatoryThis method must be implemented in all providers.
MethodgetStatisticRecordTypes
Description

Gets the supported Statistic record types.

Returnosid.type.TypeLista list containing the supported statistic record types
CompliancemandatoryThis method must be implemented.
MethodsupportsStatisticRecordType
Description

Tests if the given Statistic record type is supported.

Parametersosid.type.TypestatisticRecordTypea Type indicating a Statistic record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT statisticRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetStatisticSearchRecordTypes
Description

Gets the supported statistic search record types.

Returnosid.type.TypeLista list containing the supported statistic search record types
CompliancemandatoryThis method must be implemented.
MethodsupportsStatisticSearchRecordType
Description

Tests if the given statistic search record type is supported.

Parametersosid.type.TypestatisticSearchRecordTypea Type indicating a statistic record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT statisticSearchRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetMeterRecordTypes
Description

Gets the supported Meter record types.

Returnosid.type.TypeLista list containing the supported meter record types
CompliancemandatoryThis method must be implemented.
MethodsupportsMeterRecordType
Description

Tests if the given Meter record type is supported.

Parametersosid.type.TypemeterRecordTypea Type indicating a Meter record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT meterRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetMeterSearchRecordTypes
Description

Gets the supported meter search record types.

Returnosid.type.TypeLista list containing the supported meter search record types
CompliancemandatoryThis method must be implemented.
MethodsupportsMeterSearchRecordType
Description

Tests if the given meter search record type is supported.

Parametersosid.type.TypemeterSearchRecordTypea Type indicating a meter record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT meterSearchRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetUtilityRecordTypes
Description

Gets the supported Utility record types.

Returnosid.type.TypeLista list containing the supported utility record types
CompliancemandatoryThis method must be implemented.
MethodsupportsUtilityRecordType
Description

Tests if the given Utility record type is supported.

Parametersosid.type.TypeutilityRecordTypea Type indicating a Utility record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT utilityRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetUtilitySearchRecordTypes
Description

Gets the supported utility search record types.

Returnosid.type.TypeLista list containing the supported utility search record types
CompliancemandatoryThis method must be implemented.
MethodsupportsUtilitySearchRecordType
Description

Tests if the given utility search record type is supported.

Parametersosid.type.TypeutilitySearchRecordTypea Type indicating a utility record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT utilitySearchRecordType is null
CompliancemandatoryThis method must be implemented.