org.osid.metering

Interface Utility

All Superinterfaces:

Browsable, Extensible, Federateable, Identifiable, OsidCatalog, OsidObject, Sourceable

public interface Utility
extends OsidCatalog

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.

Method Summary

Methods

Modifier and Type	Method and Description
UtilityRecord	getUtilityRecord(Type utilityRecordType) Gets the utility record corresponding to the given Utility record Type.

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getUtilityRecord

UtilityRecord getUtilityRecord(Type utilityRecordType)
                               throws OperationFailedException

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 .

Parameters:

utilityRecordType - the type of utility record to retrieve

Returns:

the utility record

Throws:

NullArgumentException - utilityRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(utilityRecordType) is false

Compliance:

mandatory - This method must be implemented.