au.org.consumerdatastandards.holder.model.energy

Class EnergyServicePointDetailRegisters

java.lang.Object

au.org.consumerdatastandards.holder.model.energy.EnergyServicePointDetailRegisters

public class EnergyServicePointDetailRegisters
extends Object

Usage data registers available from the meter

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EnergyServicePointDetailRegisters.ConsumptionTypeEnum Actual/Subtractive Indicator.
static class	EnergyServicePointDetailRegisters.RegisterConsumptionTypeEnum Indicates the consumption type of register
static class	EnergyServicePointDetailRegisters.TimeOfDayEnum Code to identify the time validity of register contents

Constructor Summary

Constructors

Constructor and Description
EnergyServicePointDetailRegisters()

Method Summary

Modifier and Type	Method and Description
EnergyServicePointDetailRegisters	averagedDailyLoad(BigDecimal averagedDailyLoad)
EnergyServicePointDetailRegisters	consumptionType(EnergyServicePointDetailRegisters.ConsumptionTypeEnum consumptionType)
EnergyServicePointDetailRegisters	controlledLoad(Boolean controlledLoad)
boolean	equals(Object o)
@Valid BigDecimal	getAveragedDailyLoad() The energy delivered through a connection point or metering point over an extended period normalised to a 'per day' basis (kWh).
EnergyServicePointDetailRegisters.ConsumptionTypeEnum	getConsumptionType() Actual/Subtractive Indicator.
Boolean	getControlledLoad() Indicates whether the energy recorded by this register is created under a Controlled Load regime
@Valid BigDecimal	getMultiplier() Multiplier required to take a register value and turn it into a value representing billable energy
String	getNetworkTariffCode() The Network Tariff Code is a free text field containing a code supplied and published by the local network service provider
@NotNull EnergyServicePointDetailRegisters.RegisterConsumptionTypeEnum	getRegisterConsumptionType() Indicates the consumption type of register
@NotNull String	getRegisterId() Unique identifier of the register within this service point.
String	getRegisterSuffix() Register suffix of the meter register where the meter reads are obtained
EnergyServicePointDetailRegisters.TimeOfDayEnum	getTimeOfDay() Code to identify the time validity of register contents
String	getUnitOfMeasure() The unit of measure for data held in this register
int	hashCode()
EnergyServicePointDetailRegisters	multiplier(BigDecimal multiplier)
EnergyServicePointDetailRegisters	networkTariffCode(String networkTariffCode)
EnergyServicePointDetailRegisters	registerConsumptionType(EnergyServicePointDetailRegisters.RegisterConsumptionTypeEnum registerConsumptionType)
EnergyServicePointDetailRegisters	registerId(String registerId)
EnergyServicePointDetailRegisters	registerSuffix(String registerSuffix)
void	setAveragedDailyLoad(BigDecimal averagedDailyLoad)
void	setConsumptionType(EnergyServicePointDetailRegisters.ConsumptionTypeEnum consumptionType)
void	setControlledLoad(Boolean controlledLoad)
void	setMultiplier(BigDecimal multiplier)
void	setNetworkTariffCode(String networkTariffCode)
void	setRegisterConsumptionType(EnergyServicePointDetailRegisters.RegisterConsumptionTypeEnum registerConsumptionType)
void	setRegisterId(String registerId)
void	setRegisterSuffix(String registerSuffix)
void	setTimeOfDay(EnergyServicePointDetailRegisters.TimeOfDayEnum timeOfDay)
void	setUnitOfMeasure(String unitOfMeasure)
EnergyServicePointDetailRegisters	timeOfDay(EnergyServicePointDetailRegisters.TimeOfDayEnum timeOfDay)
String	toString()
EnergyServicePointDetailRegisters	unitOfMeasure(String unitOfMeasure)

Methods inherited from class java.lang.Object

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

Constructor Detail

EnergyServicePointDetailRegisters

public EnergyServicePointDetailRegisters()

Method Detail

registerId

public EnergyServicePointDetailRegisters registerId(String registerId)

getRegisterId

@NotNull
public @NotNull String getRegisterId()

Unique identifier of the register within this service point. Is not globally unique

Returns:

registerId

setRegisterId

public void setRegisterId(String registerId)

registerSuffix

public EnergyServicePointDetailRegisters registerSuffix(String registerSuffix)

getRegisterSuffix

public String getRegisterSuffix()

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

Returns:

registerSuffix

setRegisterSuffix

public void setRegisterSuffix(String registerSuffix)

averagedDailyLoad

public EnergyServicePointDetailRegisters averagedDailyLoad(BigDecimal averagedDailyLoad)

getAveragedDailyLoad

@Valid
public @Valid BigDecimal getAveragedDailyLoad()

The energy delivered through a connection point or metering point over an extended period normalised to a 'per day' basis (kWh). This value is calculated annually.

Returns:

averagedDailyLoad

setAveragedDailyLoad

public void setAveragedDailyLoad(BigDecimal averagedDailyLoad)

registerConsumptionType

public EnergyServicePointDetailRegisters registerConsumptionType(EnergyServicePointDetailRegisters.RegisterConsumptionTypeEnum registerConsumptionType)

getRegisterConsumptionType

@NotNull
public @NotNull EnergyServicePointDetailRegisters.RegisterConsumptionTypeEnum getRegisterConsumptionType()

Indicates the consumption type of register

Returns:

registerConsumptionType

setRegisterConsumptionType

public void setRegisterConsumptionType(EnergyServicePointDetailRegisters.RegisterConsumptionTypeEnum registerConsumptionType)

networkTariffCode

public EnergyServicePointDetailRegisters networkTariffCode(String networkTariffCode)

getNetworkTariffCode

public String getNetworkTariffCode()

The Network Tariff Code is a free text field containing a code supplied and published by the local network service provider

Returns:

networkTariffCode

setNetworkTariffCode

public void setNetworkTariffCode(String networkTariffCode)

unitOfMeasure

public EnergyServicePointDetailRegisters unitOfMeasure(String unitOfMeasure)

getUnitOfMeasure

public String getUnitOfMeasure()

The unit of measure for data held in this register

Returns:

unitOfMeasure

setUnitOfMeasure

public void setUnitOfMeasure(String unitOfMeasure)

timeOfDay

public EnergyServicePointDetailRegisters timeOfDay(EnergyServicePointDetailRegisters.TimeOfDayEnum timeOfDay)

getTimeOfDay

public EnergyServicePointDetailRegisters.TimeOfDayEnum getTimeOfDay()

Code to identify the time validity of register contents

Returns:

timeOfDay

setTimeOfDay

public void setTimeOfDay(EnergyServicePointDetailRegisters.TimeOfDayEnum timeOfDay)

multiplier

public EnergyServicePointDetailRegisters multiplier(BigDecimal multiplier)

getMultiplier

@Valid
public @Valid BigDecimal getMultiplier()

Multiplier required to take a register value and turn it into a value representing billable energy

Returns:

multiplier

setMultiplier

public void setMultiplier(BigDecimal multiplier)

controlledLoad

public EnergyServicePointDetailRegisters 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)

consumptionType

public EnergyServicePointDetailRegisters consumptionType(EnergyServicePointDetailRegisters.ConsumptionTypeEnum consumptionType)

getConsumptionType

public EnergyServicePointDetailRegisters.ConsumptionTypeEnum getConsumptionType()

Actual/Subtractive Indicator. Note the details of enumeration values below:

• **ACTUAL** implies volume of energy actually metered between two dates
• **CUMULATIVE** indicates a meter reading for a specific date. A second Meter Reading is required to determine the consumption between those two Meter Reading dates

Returns:

consumptionType

setConsumptionType

public void setConsumptionType(EnergyServicePointDetailRegisters.ConsumptionTypeEnum consumptionType)

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