au.org.consumerdatastandards.holder.model.energy

Class EnergyUsageRead

java.lang.Object

au.org.consumerdatastandards.holder.model.energy.EnergyUsageRead

public class EnergyUsageRead
extends Object

EnergyUsageRead

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EnergyUsageRead.ReadUTypeEnum Specify the type of the meter read data

Constructor Summary

Constructors

Constructor and Description
EnergyUsageRead()

Method Summary

Modifier and Type	Method and Description
EnergyUsageRead	basicRead(EnergyUsageReadBasicRead basicRead)
EnergyUsageRead	controlledLoad(Boolean controlledLoad)
boolean	equals(Object o)
@Valid EnergyUsageReadBasicRead	getBasicRead() Get basicRead
Boolean	getControlledLoad() Indicates whether the energy recorded by this register is created under a Controlled Load regime
@Valid EnergyUsageReadIntervalRead	getIntervalRead() Get intervalRead
String	getMeterId() Meter id/serial number as it appears in customer’s bill.
String	getReadEndDate() Date when the meter reads end in AEST.
@NotNull String	getReadStartDate() Date when the meter reads start in AEST and assumed to start from 12:00 am AEST.
@NotNull EnergyUsageRead.ReadUTypeEnum	getReadUType() Specify the type of the meter read data
String	getRegisterId() Register ID of the meter register where the meter reads are obtained
@NotNull String	getRegisterSuffix() Register suffix of the meter register where the meter reads are obtained
@NotNull String	getServicePointId() Tokenised ID of the service point to be used for referring to the service point in the CDR API suite.
String	getUnitOfMeasure() Unit of measure of the meter reads.
int	hashCode()
EnergyUsageRead	intervalRead(EnergyUsageReadIntervalRead intervalRead)
EnergyUsageRead	meterId(String meterId)
EnergyUsageRead	readEndDate(String readEndDate)
EnergyUsageRead	readStartDate(String readStartDate)
EnergyUsageRead	readUType(EnergyUsageRead.ReadUTypeEnum readUType)
EnergyUsageRead	registerId(String registerId)
EnergyUsageRead	registerSuffix(String registerSuffix)
EnergyUsageRead	servicePointId(String servicePointId)
void	setBasicRead(EnergyUsageReadBasicRead basicRead)
void	setControlledLoad(Boolean controlledLoad)
void	setIntervalRead(EnergyUsageReadIntervalRead intervalRead)
void	setMeterId(String meterId)
void	setReadEndDate(String readEndDate)
void	setReadStartDate(String readStartDate)
void	setReadUType(EnergyUsageRead.ReadUTypeEnum readUType)
void	setRegisterId(String registerId)
void	setRegisterSuffix(String registerSuffix)
void	setServicePointId(String servicePointId)
void	setUnitOfMeasure(String unitOfMeasure)
String	toString()
EnergyUsageRead	unitOfMeasure(String unitOfMeasure)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

EnergyUsageRead

public EnergyUsageRead()

Method Detail

servicePointId

public EnergyUsageRead servicePointId(String servicePointId)

getServicePointId

@NotNull
public @NotNull String getServicePointId()

Tokenised ID of the service point to be used for referring to the service point in the CDR API suite. To be created in accordance with CDR ID permanence requirements

Returns:

servicePointId

setServicePointId

public void setServicePointId(String servicePointId)

registerId

public EnergyUsageRead registerId(String registerId)

getRegisterId

public String getRegisterId()

Register ID of the meter register where the meter reads are obtained

Returns:

registerId

setRegisterId

public void setRegisterId(String registerId)

registerSuffix

public EnergyUsageRead registerSuffix(String registerSuffix)

getRegisterSuffix

@NotNull
public @NotNull String getRegisterSuffix()

Register suffix of the meter register where the meter reads are obtained

Returns:

registerSuffix

setRegisterSuffix

public void setRegisterSuffix(String registerSuffix)

meterId

public EnergyUsageRead meterId(String meterId)

getMeterId

public String getMeterId()

Meter id/serial number as it appears in customer’s bill. ID permanence rules do not apply.

Returns:

meterId

setMeterId

public void setMeterId(String meterId)

controlledLoad

public EnergyUsageRead controlledLoad(Boolean controlledLoad)

getControlledLoad

public Boolean getControlledLoad()

Indicates whether the energy recorded by this register is created under a Controlled Load regime

Returns:

controlledLoad

setControlledLoad

public void setControlledLoad(Boolean controlledLoad)

readStartDate

public EnergyUsageRead readStartDate(String readStartDate)

getReadStartDate

@NotNull
public @NotNull String getReadStartDate()

Date when the meter reads start in AEST and assumed to start from 12:00 am AEST.

Returns:

readStartDate

setReadStartDate

public void setReadStartDate(String readStartDate)

readEndDate

public EnergyUsageRead readEndDate(String readEndDate)

getReadEndDate

public String getReadEndDate()

Date when the meter reads end in AEST. If absent then assumed to be equal to readStartDate. In this case the entry represents data for a single date specified by readStartDate.

Returns:

readEndDate

setReadEndDate

public void setReadEndDate(String readEndDate)

unitOfMeasure

public EnergyUsageRead unitOfMeasure(String unitOfMeasure)

getUnitOfMeasure

public String getUnitOfMeasure()

Unit of measure of the meter reads. Refer to Appendix B of MDFF Specification NEM12 NEM13 v2.1 for a list of possible values.

Returns:

unitOfMeasure

setUnitOfMeasure

public void setUnitOfMeasure(String unitOfMeasure)

readUType

public EnergyUsageRead readUType(EnergyUsageRead.ReadUTypeEnum readUType)

getReadUType

@NotNull
public @NotNull EnergyUsageRead.ReadUTypeEnum getReadUType()

Specify the type of the meter read data

Returns:

readUType

setReadUType

public void setReadUType(EnergyUsageRead.ReadUTypeEnum readUType)

basicRead

public EnergyUsageRead basicRead(EnergyUsageReadBasicRead basicRead)

getBasicRead

@Valid
public @Valid EnergyUsageReadBasicRead getBasicRead()

Get basicRead

Returns:

basicRead

setBasicRead

public void setBasicRead(EnergyUsageReadBasicRead basicRead)

intervalRead

public EnergyUsageRead intervalRead(EnergyUsageReadIntervalRead intervalRead)

getIntervalRead

@Valid
public @Valid EnergyUsageReadIntervalRead getIntervalRead()

Get intervalRead

Returns:

intervalRead

setIntervalRead

public void setIntervalRead(EnergyUsageReadIntervalRead intervalRead)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object