Interface MeteringProfile

All Superinterfaces:
OsidProfile, Sourceable
All Known Subinterfaces:
MeteringManager, MeteringProxyManager
public interface MeteringProfile extends OsidProfile

The metering profile describes the interoperability among metering services.

  • Method Details

    • supportsVisibleFederation

      boolean supportsVisibleFederation()
      Tests if visible federation is supported.
      Returns:
      true if visible federation is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsMeterReading

      boolean supportsMeterReading()
      Tests if reading meters is supported.
      Returns:
      true if reading meters is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsStatisticLookup

      boolean supportsStatisticLookup()
      Tests if statistical lookup is supported.
      Returns:
      true if statistical lookup is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsStatisticQuery

      boolean supportsStatisticQuery()
      Tests if statistical query is supported.
      Returns:
      true if statistical query is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsStatisticSearch

      boolean supportsStatisticSearch()
      Tests if statistical search is supported.
      Returns:
      true if statistical search is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsStatisticNotification

      boolean supportsStatisticNotification()
      Tests if statistical notification is supported.
      Returns:
      true if statistical notification is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsStatisticSmartUtility

      boolean supportsStatisticSmartUtility()
      Tests if statistical smart utilitiy is supported.
      Returns:
      true if statistical smart utility is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsMeterLookup

      boolean supportsMeterLookup()
      Tests if looking up meters is supported.
      Returns:
      true if looking up meters is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsMeterQuery

      boolean supportsMeterQuery()
      Tests if querying meters is supported.
      Returns:
      true if querying meters is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsMeterSearch

      boolean supportsMeterSearch()
      Tests if searching meters is supported.
      Returns:
      true if searching meters is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsMeterNotification

      boolean supportsMeterNotification()
      Tests if meter notification is supported,.
      Returns:
      true if meter notification is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsMeterUtility

      boolean supportsMeterUtility()
      Tests if looking up meter utlity mappings is supported,.
      Returns:
      true if utility meter mapping is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsMeterUtilityAssignment

      boolean supportsMeterUtilityAssignment()
      Tests if managing meter utlity mappings is supported,.
      Returns:
      true if assigning utility meter mappings is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsSmartMeterUtility

      boolean supportsSmartMeterUtility()
      Tests if managing meter smart utlity service is supported,.
      Returns:
      true if a meter smart utility service is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsUtilityLookup

      boolean supportsUtilityLookup()
      Tests for the availability of a utility lookup service.
      Returns:
      true if utility lookup is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsUtilityQuery

      boolean supportsUtilityQuery()
      Tests for the availability of a utility query service.
      Returns:
      true if utility query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsUtilitySearch

      boolean supportsUtilitySearch()
      Tests if searching for utilities is available.
      Returns:
      true if utility search is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsUtilityAdmin

      boolean supportsUtilityAdmin()
      Tests for the availability of a utility administrative service for creating and deleting utilities.
      Returns:
      true if utility administration is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsUtilityNotification

      boolean supportsUtilityNotification()
      Tests for the availability of a utility notification service.
      Returns:
      true if utility notification is available, false otherwise
      Compliance:
      mandatory - This method must be implemented in all providers.

    • supportsUtilityHierarchy

      boolean supportsUtilityHierarchy()
      Tests for the availability of a utility hierarchy traversal service.
      Returns:
      true if utility hierarchy traversal is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsUtilityHierarchyDesign

      boolean supportsUtilityHierarchyDesign()
      Tests for the availability of a utility hierarchy design service.
      Returns:
      true if utility hierarchy design is available, false otherwise
      Compliance:
      mandatory - This method must be implemented in all providers.

    • supportsMeteringBatch

      boolean supportsMeteringBatch()
      Tests for the availability of a metering batch service.
      Returns:
      true if metering batch service is available, false otherwise
      Compliance:
      mandatory - This method must be implemented in all providers.

    • supportsMeteringThreshold

      boolean supportsMeteringThreshold()
      Tests for the availability of a metering threshold service.
      Returns:
      true if a metering threshold service is available, false otherwise
      Compliance:
      mandatory - This method must be implemented in all providers.

    • getStatisticRecordTypes

      TypeList getStatisticRecordTypes()
      Gets the supported Statistic record types.
      Returns:
      a list containing the supported statistic record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsStatisticRecordType

      boolean supportsStatisticRecordType(Type statisticRecordType)
      Tests if the given Statistic record type is supported.
      Parameters:
      statisticRecordType - a Type indicating a Statistic record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - statisticRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getStatisticSearchRecordTypes

      TypeList getStatisticSearchRecordTypes()
      Gets the supported statistic search record types.
      Returns:
      a list containing the supported statistic search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsStatisticSearchRecordType

      boolean supportsStatisticSearchRecordType(Type statisticSearchRecordType)
      Tests if the given statistic search record type is supported.
      Parameters:
      statisticSearchRecordType - a Type indicating a statistic record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - statisticSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getMeterRecordTypes

      TypeList getMeterRecordTypes()
      Gets the supported Meter record types.
      Returns:
      a list containing the supported meter record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsMeterRecordType

      boolean supportsMeterRecordType(Type meterRecordType)
      Tests if the given Meter record type is supported.
      Parameters:
      meterRecordType - a Type indicating a Meter record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - meterRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getMeterSearchRecordTypes

      TypeList getMeterSearchRecordTypes()
      Gets the supported meter search record types.
      Returns:
      a list containing the supported meter search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsMeterSearchRecordType

      boolean supportsMeterSearchRecordType(Type meterSearchRecordType)
      Tests if the given meter search record type is supported.
      Parameters:
      meterSearchRecordType - a Type indicating a meter record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - meterSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getUtilityRecordTypes

      TypeList getUtilityRecordTypes()
      Gets the supported Utility record types.
      Returns:
      a list containing the supported utility record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsUtilityRecordType

      boolean supportsUtilityRecordType(Type utilityRecordType)
      Tests if the given Utility record type is supported.
      Parameters:
      utilityRecordType - a Type indicating a Utility record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - utilityRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getUtilitySearchRecordTypes

      TypeList getUtilitySearchRecordTypes()
      Gets the supported utility search record types.
      Returns:
      a list containing the supported utility search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsUtilitySearchRecordType

      boolean supportsUtilitySearchRecordType(Type utilitySearchRecordType)
      Tests if the given utility search record type is supported.
      Parameters:
      utilitySearchRecordType - a Type indicating a utility record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - utilitySearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.