org.osid.metering

Interface Reading

All Superinterfaces:

OsidCapsule

public interface Reading
extends OsidCapsule

A Reading represents data from a Meter for a referenced metered object at the current point in time.

Method Summary

Methods

Modifier and Type	Method and Description
java.math.BigDecimal	getAmount() Gets the amount of this reading.
Meter	getMeter() Gets the Meter associated with this reading.
Id	getMeteredObjectId() Gets the metered object associated with this reading.
Id	getMeterId() Gets the Id of the Meter associated with this reading.

Method Detail

getMeterId

Id getMeterId()

Gets the Id of the Meter associated with this reading.

Returns:

gets the Id of the Meter

Compliance:

mandatory - This method must be implemented.

getMeter

Meter getMeter()
               throws OperationFailedException

Gets the Meter associated with this reading.

Returns:

gets the Meter

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getMeteredObjectId

Id getMeteredObjectId()

Gets the metered object associated with this reading.

Returns:

gets the metered object Id

Compliance:

mandatory - This method must be implemented.

getAmount

java.math.BigDecimal getAmount()

Gets the amount of this reading.

Returns:

gets the amount of this reading

Compliance:

mandatory - This method must be implemented.