org.osid.metering

Interface Meter

All Superinterfaces:

Browsable, Extensible, Identifiable, OsidObject

public interface Meter
extends OsidObject

A Meter represents a measure. The measured value for a reference metered object is available in a Reading.

Method Summary

Methods

Modifier and Type	Method and Description
MeterRecord	getMeterRecord(Type meterRecordType) Gets the meter record corresponding to the given Meter 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

Method Detail

getMeterRecord

MeterRecord getMeterRecord(Type meterRecordType)
                           throws OperationFailedException

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

Parameters:

meterRecordType - the meter record type

Returns:

the meter record

Throws:

NullArgumentException - meterRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(meterRecordType) is false

Compliance:

mandatory - This method must be implemented.