OSID - osid.metering.MeteringProfile Service Interface Definition

Interface	osid.metering.MeteringProfile
Implements	`osid.OsidProfile`
Description	The metering profile describes the interoperability among metering services.
Method	supportsVisibleFederation
Description	Tests if visible federation is supported.
Return	`boolean`		`true` if visible federation is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsMeterReading
Description	Tests if reading meters is supported.
Return	`boolean`		`true` if reading meters is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsStatisticLookup
Description	Tests if statistical lookup is supported.
Return	`boolean`		`true` if statistical lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsStatisticQuery
Description	Tests if statistical query is supported.
Return	`boolean`		`true` if statistical query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsStatisticSearch
Description	Tests if statistical search is supported.
Return	`boolean`		`true` if statistical search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsStatisticNotification
Description	Tests if statistical notification is supported.
Return	`boolean`		`true` if statistical notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsStatisticSmartUtility
Description	Tests if statistical smart utilitiy is supported.
Return	`boolean`		`true` if statistical smart utility is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsMeterLookup
Description	Tests if looking up meters is supported.
Return	`boolean`		`true` if looking up meters is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsMeterQuery
Description	Tests if querying meters is supported.
Return	`boolean`		`true` if querying meters is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsMeterSearch
Description	Tests if searching meters is supported.
Return	`boolean`		`true` if searching meters is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsMeterNotification
Description	Tests if meter notification is supported,.
Return	`boolean`		`true` if meter notification is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsMeterUtility
Description	Tests if looking up meter utlity mappings is supported,.
Return	`boolean`		`true` if utility meter mapping is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsMeterUtilityAssignment
Description	Tests if managing meter utlity mappings is supported,.
Return	`boolean`		`true` if assigning utility meter mappings is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsSmartMeterUtility
Description	Tests if managing meter smart utlity service is supported,.
Return	`boolean`		`true` if a meter smart utility service is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsUtilityLookup
Description	Tests for the availability of a utility lookup service.
Return	`boolean`		`true` if utility lookup is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsUtilityQuery
Description	Tests for the availability of a utility query service.
Return	`boolean`		`true` if utility query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsUtilitySearch
Description	Tests if searching for utilities is available.
Return	`boolean`		`true` if utility search is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsUtilityAdmin
Description	Tests for the availability of a utility administrative service for creating and deleting utilities.
Return	`boolean`		`true` if utility administration is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsUtilityNotification
Description	Tests for the availability of a utility notification service.
Return	`boolean`		`true` if utility notification is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	supportsUtilityHierarchy
Description	Tests for the availability of a utility hierarchy traversal service.
Return	`boolean`		`true` if utility hierarchy traversal is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsUtilityHierarchyDesign
Description	Tests for the availability of a utility hierarchy design service.
Return	`boolean`		`true` if utility hierarchy design is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	supportsMeteringBatch
Description	Tests for the availability of a metering batch service.
Return	`boolean`		`true` if metering batch service is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	supportsMeteringThreshold
Description	Tests for the availability of a metering threshold service.
Return	`boolean`		`true` if metering threshold service is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	getStatisticRecordTypes
Description	Gets the supported `Statistic` record types.
Return	`osid.type.TypeList`		a list containing the supported statistic record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsStatisticRecordType
Description	Tests if the given `Statistic` record type is supported.
Parameters	`osid.type.Type`	`statisticRecordType`	a `Type` indicating a `Statistic` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`statisticRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getStatisticSearchRecordTypes
Description	Gets the supported statistic search record types.
Return	`osid.type.TypeList`		a list containing the supported statistic search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsStatisticSearchRecordType
Description	Tests if the given statistic search record type is supported.
Parameters	`osid.type.Type`	`statisticSearchRecordType`	a `Type` indicating a statistic record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`statisticSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getMeterRecordTypes
Description	Gets the supported `Meter` record types.
Return	`osid.type.TypeList`		a list containing the supported meter record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsMeterRecordType
Description	Tests if the given `Meter` record type is supported.
Parameters	`osid.type.Type`	`meterRecordType`	a `Type` indicating a `Meter` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`meterRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getMeterSearchRecordTypes
Description	Gets the supported meter search record types.
Return	`osid.type.TypeList`		a list containing the supported meter search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsMeterSearchRecordType
Description	Tests if the given meter search record type is supported.
Parameters	`osid.type.Type`	`meterSearchRecordType`	a `Type` indicating a meter record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`meterSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getUtilityRecordTypes
Description	Gets the supported `Utility` record types.
Return	`osid.type.TypeList`		a list containing the supported utility record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsUtilityRecordType
Description	Tests if the given `Utility` record type is supported.
Parameters	`osid.type.Type`	`utilityRecordType`	a `Type` indicating a `Utility` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`utilityRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getUtilitySearchRecordTypes
Description	Gets the supported utility search record types.
Return	`osid.type.TypeList`		a list containing the supported utility search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsUtilitySearchRecordType
Description	Tests if the given utility search record type is supported.
Parameters	`osid.type.Type`	`utilitySearchRecordType`	a `Type` indicating a utility record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`utilitySearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.