OSID Logo
OSID Specifications
metering package
Version 3.0.0
Release Candidate Preview
Interfaceosid.metering.Utility
Implementsosid.OsidCatalog
Description

A Utility represents a collection of Meters. Like all OSID objects, a Utility is identified by its Id and any persisted references should use the Id.

MethodgetUtilityRecord
Description

Gets the utility record corresponding to the given Utility record Type. This method is used to retrieve an object implementing the requested record. The utilityRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(utilityRecordType) is true .

Parametersosid.type.TypeutilityRecordTypethe type of utility record to retrieve
Returnosid.metering.records.UtilityRecordthe utility record
ErrorsNULL_ARGUMENT utilityRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(utilityRecordType) is false
CompliancemandatoryThis method must be implemented.