au.org.consumerdatastandards.holder.model.energy

Class EnergyPlanContractTariffPeriod

java.lang.Object

au.org.consumerdatastandards.holder.model.energy.EnergyPlanContractTariffPeriod

@Entity
public class EnergyPlanContractTariffPeriod
extends Object

EnergyPlanContractTariffPeriod

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EnergyPlanContractTariffPeriod.RateBlockUTypeEnum Specifies the type of rate applicable to this tariff period
static class	EnergyPlanContractTariffPeriod.TimeZone Specifies the charge specific time zone for calculation of the time of use thresholds.
static class	EnergyPlanContractTariffPeriod.TypeEnum Type of charge.

Constructor Summary

Constructors

Constructor and Description
EnergyPlanContractTariffPeriod()

Method Summary

Modifier and Type	Method and Description
EnergyPlanContractTariffPeriod	addDemandChargesItem(EnergyPlanContractDemandCharges demandChargesItem)
EnergyPlanContractTariffPeriod	addTimeOfUseRatesItem(EnergyPlanContractTimeOfUseRates timeOfUseRatesItem)
EnergyPlanContractTariffPeriod	dailySupplyCharges(String dailySupplyCharges)
EnergyPlanContractTariffPeriod	demandCharges(List<EnergyPlanContractDemandCharges> demandCharges)
EnergyPlanContractTariffPeriod	displayName(String displayName)
EnergyPlanContractTariffPeriod	endDate(String endDate)
boolean	equals(Object o)
String	getDailySupplyCharges() The amount of access charge for the tariff period, in dollars per day exclusive of GST.
@Valid List<EnergyPlanContractDemandCharges>	getDemandCharges() Array of demand charges.
@NotNull String	getDisplayName() The name of the tariff period
@NotNull String	getEndDate() The end date of the tariff period in a calendar year.
String	getId()
@NotNull EnergyPlanContractTariffPeriod.RateBlockUTypeEnum	getRateBlockUType() Specifies the type of rate applicable to this tariff period
@Valid EnergyPlanContractSingleRate	getSingleRate() Get singleRate
@NotNull String	getStartDate() The start date of the tariff period in a calendar year.
@Valid List<EnergyPlanContractTimeOfUseRates>	getTimeOfUseRates() Array of objects representing time of use rates.
EnergyPlanContractTariffPeriod.TimeZone	getTimeZone() Specifies the charge specific time zone for calculation of the time of use thresholds.
EnergyPlanContractTariffPeriod.TypeEnum	getType() Type of charge.
int	hashCode()
EnergyPlanContractTariffPeriod	rateBlockUType(EnergyPlanContractTariffPeriod.RateBlockUTypeEnum rateBlockUType)
void	setDailySupplyCharges(String dailySupplyCharges)
void	setDemandCharges(List<EnergyPlanContractDemandCharges> demandCharges)
void	setDisplayName(String displayName)
void	setEndDate(String endDate)
void	setId(String id)
void	setRateBlockUType(EnergyPlanContractTariffPeriod.RateBlockUTypeEnum rateBlockUType)
void	setSingleRate(EnergyPlanContractSingleRate singleRate)
void	setStartDate(String startDate)
void	setTimeOfUseRates(List<EnergyPlanContractTimeOfUseRates> timeOfUseRates)
void	setTimeZone(EnergyPlanContractTariffPeriod.TimeZone timeZone)
void	setType(EnergyPlanContractTariffPeriod.TypeEnum type)
EnergyPlanContractTariffPeriod	singleRate(EnergyPlanContractSingleRate singleRate)
EnergyPlanContractTariffPeriod	startDate(String startDate)
EnergyPlanContractTariffPeriod	timeOfUseRates(List<EnergyPlanContractTimeOfUseRates> timeOfUseRates)
String	toString()
EnergyPlanContractTariffPeriod	type(EnergyPlanContractTariffPeriod.TypeEnum type)

Methods inherited from class java.lang.Object

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

Constructor Detail

EnergyPlanContractTariffPeriod

public EnergyPlanContractTariffPeriod()

Method Detail

getId

public String getId()

setId

public void setId(String id)

type

public EnergyPlanContractTariffPeriod type(EnergyPlanContractTariffPeriod.TypeEnum type)

getType

public EnergyPlanContractTariffPeriod.TypeEnum getType()

Type of charge. Assumed to be other if absent

Returns:

type

setType

public void setType(EnergyPlanContractTariffPeriod.TypeEnum type)

displayName

public EnergyPlanContractTariffPeriod displayName(String displayName)

getDisplayName

@NotNull
public @NotNull String getDisplayName()

The name of the tariff period

Returns:

displayName

setDisplayName

public void setDisplayName(String displayName)

startDate

public EnergyPlanContractTariffPeriod startDate(String startDate)

getStartDate

@NotNull
public @NotNull String getStartDate()

The start date of the tariff period in a calendar year. Formatted in mm-dd format

Returns:

startDate

setStartDate

public void setStartDate(String startDate)

endDate

public EnergyPlanContractTariffPeriod endDate(String endDate)

getEndDate

@NotNull
public @NotNull String getEndDate()

The end date of the tariff period in a calendar year. Formatted in mm-dd format

Returns:

endDate

setEndDate

public void setEndDate(String endDate)

dailySupplyCharges

public EnergyPlanContractTariffPeriod dailySupplyCharges(String dailySupplyCharges)

getDailySupplyCharges

public String getDailySupplyCharges()

The amount of access charge for the tariff period, in dollars per day exclusive of GST.

Returns:

dailySupplyCharges

setDailySupplyCharges

public void setDailySupplyCharges(String dailySupplyCharges)

getTimeZone

public EnergyPlanContractTariffPeriod.TimeZone getTimeZone()

Specifies the charge specific time zone for calculation of the time of use thresholds. If absent, timezone value in EnergyPlanContract is assumed.

Returns:

timeZone

setTimeZone

public void setTimeZone(EnergyPlanContractTariffPeriod.TimeZone timeZone)

rateBlockUType

public EnergyPlanContractTariffPeriod rateBlockUType(EnergyPlanContractTariffPeriod.RateBlockUTypeEnum rateBlockUType)

getRateBlockUType

@NotNull
public @NotNull EnergyPlanContractTariffPeriod.RateBlockUTypeEnum getRateBlockUType()

Specifies the type of rate applicable to this tariff period

Returns:

rateBlockUType

setRateBlockUType

public void setRateBlockUType(EnergyPlanContractTariffPeriod.RateBlockUTypeEnum rateBlockUType)

singleRate

public EnergyPlanContractTariffPeriod singleRate(EnergyPlanContractSingleRate singleRate)

getSingleRate

@Valid
public @Valid EnergyPlanContractSingleRate getSingleRate()

Get singleRate

Returns:

singleRate

setSingleRate

public void setSingleRate(EnergyPlanContractSingleRate singleRate)

timeOfUseRates

public EnergyPlanContractTariffPeriod timeOfUseRates(List<EnergyPlanContractTimeOfUseRates> timeOfUseRates)

addTimeOfUseRatesItem

public EnergyPlanContractTariffPeriod addTimeOfUseRatesItem(EnergyPlanContractTimeOfUseRates timeOfUseRatesItem)

getTimeOfUseRates

@Valid
public @Valid List<EnergyPlanContractTimeOfUseRates> getTimeOfUseRates()

Array of objects representing time of use rates. Required if rateBlockUType is timeOfUseRates

Returns:

timeOfUseRates

setTimeOfUseRates

public void setTimeOfUseRates(List<EnergyPlanContractTimeOfUseRates> timeOfUseRates)

demandCharges

public EnergyPlanContractTariffPeriod demandCharges(List<EnergyPlanContractDemandCharges> demandCharges)

addDemandChargesItem

public EnergyPlanContractTariffPeriod addDemandChargesItem(EnergyPlanContractDemandCharges demandChargesItem)

getDemandCharges

@Valid
public @Valid List<EnergyPlanContractDemandCharges> getDemandCharges()

Array of demand charges. Required if rateBlockUType is demandCharges

Returns:

demandCharges

setDemandCharges

public void setDemandCharges(List<EnergyPlanContractDemandCharges> demandCharges)

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