au.org.consumerdatastandards.holder.model.energy

Class EnergyPlanContract

java.lang.Object

au.org.consumerdatastandards.holder.model.energy.EnergyPlanContract

@Entity
public class EnergyPlanContract
extends Object

EnergyPlanContract

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EnergyPlanContract.PaymentOptionEnum Gets or Sets paymentOption
static class	EnergyPlanContract.PricingModelEnum The pricing model for the contract.
static class	EnergyPlanContract.TimeZoneEnum Required if pricingModel is set to TIME_OF_USE.

Constructor Summary

Constructors

Constructor and Description
EnergyPlanContract()

Method Summary

Modifier and Type	Method and Description
EnergyPlanContract	addDiscountsItem(EnergyPlanContractDiscounts discountsItem)
EnergyPlanContract	addEligibilityItem(EnergyPlanContractEligibility eligibilityItem)
EnergyPlanContract	addFeesItem(EnergyPlanContractFees feesItem)
EnergyPlanContract	addGreenPowerChargesItem(EnergyPlanContractGreenPowerCharges greenPowerChargesItem)
EnergyPlanContract	addIncentivesItem(EnergyPlanContractIncentives incentivesItem)
EnergyPlanContract	additionalFeeInformation(String additionalFeeInformation)
EnergyPlanContract	addPaymentOptionItem(EnergyPlanContract.PaymentOptionEnum paymentOptionItem)
EnergyPlanContract	addSolarFeedInTariffItem(EnergyPlanContractSolarFeedInTariff solarFeedInTariffItem)
EnergyPlanContract	addTariffPeriodItem(EnergyPlanContractTariffPeriod tariffPeriodItem)
EnergyPlanContract	controlledLoad(List<EnergyPlanControlledLoad> controlledLoad)
EnergyPlanContract	discounts(List<EnergyPlanContractDiscounts> discounts)
EnergyPlanContract	eligibility(List<EnergyPlanContractEligibility> eligibility)
boolean	equals(Object o)
EnergyPlanContract	fees(List<EnergyPlanContractFees> fees)
String	getAdditionalFeeInformation() Free text field containing additional information of the fees for this contract
List<EnergyPlanControlledLoad>	getControlledLoad() Get controlledLoad
@Valid List<EnergyPlanContractDiscounts>	getDiscounts() Optional list of discounts available for the contract
@Valid List<EnergyPlanContractEligibility>	getEligibility() Eligibility restrictions or requirements
@Valid List<EnergyPlanContractFees>	getFees() An array of fees applicable to the plan
@Valid List<EnergyPlanContractGreenPowerCharges>	getGreenPowerCharges() Optional list of charges applicable to green power
@Valid List<EnergyPlanContractIncentives>	getIncentives() Optional list of incentives available for the contract
@Valid EnergyPlanContractIntrinsicGreenPower	getIntrinsicGreenPower() Get intrinsicGreenPower
@NotNull Boolean	getIsFixed() Flag indicating whether prices are fixed or variable
String	getOnExpiryDescription() Free text field that describes what will occur on or prior to expiry of the fixed contract term or benefit period
@NotNull List<EnergyPlanContract.PaymentOptionEnum>	getPaymentOption() Payment options for this contract
@NotNull EnergyPlanContract.PricingModelEnum	getPricingModel() The pricing model for the contract.
@Valid List<EnergyPlanContractSolarFeedInTariff>	getSolarFeedInTariff() Array of feed in tariffs for solar power
@NotNull @Valid List<EnergyPlanContractTariffPeriod>	getTariffPeriod() Array of tariff periods
EnergyPlanContract.TimeZoneEnum	getTimeZone() Required if pricingModel is set to TIME_OF_USE.
String	getVariation() Free text description of price variation policy and conditions for the contract.
EnergyPlanContract	greenPowerCharges(List<EnergyPlanContractGreenPowerCharges> greenPowerCharges)
int	hashCode()
EnergyPlanContract	incentives(List<EnergyPlanContractIncentives> incentives)
EnergyPlanContract	intrinsicGreenPower(EnergyPlanContractIntrinsicGreenPower intrinsicGreenPower)
EnergyPlanContract	isFixed(Boolean isFixed)
EnergyPlanContract	onExpiryDescription(String onExpiryDescription)
EnergyPlanContract	paymentOption(List<EnergyPlanContract.PaymentOptionEnum> paymentOption)
EnergyPlanContract	pricingModel(EnergyPlanContract.PricingModelEnum pricingModel)
void	setAdditionalFeeInformation(String additionalFeeInformation)
void	setControlledLoad(List<EnergyPlanControlledLoad> controlledLoad)
void	setDiscounts(List<EnergyPlanContractDiscounts> discounts)
void	setEligibility(List<EnergyPlanContractEligibility> eligibility)
void	setFees(List<EnergyPlanContractFees> fees)
void	setGreenPowerCharges(List<EnergyPlanContractGreenPowerCharges> greenPowerCharges)
void	setIncentives(List<EnergyPlanContractIncentives> incentives)
void	setIntrinsicGreenPower(EnergyPlanContractIntrinsicGreenPower intrinsicGreenPower)
void	setIsFixed(Boolean isFixed)
void	setOnExpiryDescription(String onExpiryDescription)
void	setPaymentOption(List<EnergyPlanContract.PaymentOptionEnum> paymentOption)
void	setPricingModel(EnergyPlanContract.PricingModelEnum pricingModel)
void	setSolarFeedInTariff(List<EnergyPlanContractSolarFeedInTariff> solarFeedInTariff)
void	setTariffPeriod(List<EnergyPlanContractTariffPeriod> tariffPeriod)
void	setTimeZone(EnergyPlanContract.TimeZoneEnum timeZone)
void	setVariation(String variation)
EnergyPlanContract	solarFeedInTariff(List<EnergyPlanContractSolarFeedInTariff> solarFeedInTariff)
EnergyPlanContract	tariffPeriod(List<EnergyPlanContractTariffPeriod> tariffPeriod)
EnergyPlanContract	timeZone(EnergyPlanContract.TimeZoneEnum timeZone)
String	toString()
EnergyPlanContract	variation(String variation)

Methods inherited from class java.lang.Object

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

Constructor Detail

EnergyPlanContract

public EnergyPlanContract()

Method Detail

additionalFeeInformation

public EnergyPlanContract additionalFeeInformation(String additionalFeeInformation)

getAdditionalFeeInformation

public String getAdditionalFeeInformation()

Free text field containing additional information of the fees for this contract

Returns:

additionalFeeInformation

setAdditionalFeeInformation

public void setAdditionalFeeInformation(String additionalFeeInformation)

pricingModel

public EnergyPlanContract pricingModel(EnergyPlanContract.PricingModelEnum pricingModel)

getPricingModel

@NotNull
public @NotNull EnergyPlanContract.PricingModelEnum getPricingModel()

The pricing model for the contract. Contracts for gas must use SINGLE_RATE. Note that the detail for the enumeration values are:

• **SINGLE_RATE** - all energy usage is charged at a single unit rate no matter when it is consumed. Multiple unit rates may exist that correspond to varying volumes of usage i.e. a ‘block’ or ‘step’ tariff (first 50kWh @ X cents, next 50kWh at Y cents etc.
• **SINGLE_RATE_CONT_LOAD** - as above, but with an additional, separate unit rate charged for all energy usage from a controlled load i.e. separately metered appliance like hot water service, pool pump etc.
• **TIME_OF_USE** - energy usage is charged at unit rates that vary dependent on time of day and day of week that the energy is consumed
• **TIME_OF_USE_CONT_LOAD** - as above, but with an additional, separate unit rate charged for all energy usage from a controlled load i.e. separately metered appliance like hot water service, pool pump etc.
• **FLEXIBLE** - energy usage is charged at unit rates that vary based on external factors
• **FLEXIBLE_CONT_LOAD** - as above, but with an additional, separate unit rate charged for all energy usage from a controlled load i.e. separately metered appliance like hot water service, pool pump etc.
• **QUOTA** - all energy usage is charged at a single fixed rate, up to a specified usage quota/allowance. All excess usage beyond the allowance is then charged at a single unit rate (may not be the best way to explain it but it is essentially a ‘subscription’ or telco style product i.e. $50/month for up to 150kWh included usage

Returns:

pricingModel

setPricingModel

public void setPricingModel(EnergyPlanContract.PricingModelEnum pricingModel)

timeZone

public EnergyPlanContract timeZone(EnergyPlanContract.TimeZoneEnum timeZone)

getTimeZone

public EnergyPlanContract.TimeZoneEnum getTimeZone()

Required if pricingModel is set to TIME_OF_USE. Defines the time zone to use for calculation of the time of use thresholds. Defaults to AEST if absent

Returns:

timeZone

setTimeZone

public void setTimeZone(EnergyPlanContract.TimeZoneEnum timeZone)

isFixed

public EnergyPlanContract isFixed(Boolean isFixed)

getIsFixed

@NotNull
public @NotNull Boolean getIsFixed()

Flag indicating whether prices are fixed or variable

Returns:

isFixed

setIsFixed

public void setIsFixed(Boolean isFixed)

variation

public EnergyPlanContract variation(String variation)

getVariation

public String getVariation()

Free text description of price variation policy and conditions for the contract. Mandatory if `isFixed` is false

Returns:

variation

setVariation

public void setVariation(String variation)

onExpiryDescription

public EnergyPlanContract onExpiryDescription(String onExpiryDescription)

getOnExpiryDescription

public String getOnExpiryDescription()

Free text field that describes what will occur on or prior to expiry of the fixed contract term or benefit period

Returns:

onExpiryDescription

setOnExpiryDescription

public void setOnExpiryDescription(String onExpiryDescription)

paymentOption

public EnergyPlanContract paymentOption(List<EnergyPlanContract.PaymentOptionEnum> paymentOption)

addPaymentOptionItem

public EnergyPlanContract addPaymentOptionItem(EnergyPlanContract.PaymentOptionEnum paymentOptionItem)

getPaymentOption

@NotNull
public @NotNull List<EnergyPlanContract.PaymentOptionEnum> getPaymentOption()

Payment options for this contract

Returns:

paymentOption

setPaymentOption

public void setPaymentOption(List<EnergyPlanContract.PaymentOptionEnum> paymentOption)

intrinsicGreenPower

public EnergyPlanContract intrinsicGreenPower(EnergyPlanContractIntrinsicGreenPower intrinsicGreenPower)

getIntrinsicGreenPower

@Valid
public @Valid EnergyPlanContractIntrinsicGreenPower getIntrinsicGreenPower()

Get intrinsicGreenPower

Returns:

intrinsicGreenPower

setIntrinsicGreenPower

public void setIntrinsicGreenPower(EnergyPlanContractIntrinsicGreenPower intrinsicGreenPower)

controlledLoad

public EnergyPlanContract controlledLoad(List<EnergyPlanControlledLoad> controlledLoad)

getControlledLoad

public List<EnergyPlanControlledLoad> getControlledLoad()

Get controlledLoad

Returns:

controlledLoad

setControlledLoad

public void setControlledLoad(List<EnergyPlanControlledLoad> controlledLoad)

incentives

public EnergyPlanContract incentives(List<EnergyPlanContractIncentives> incentives)

addIncentivesItem

public EnergyPlanContract addIncentivesItem(EnergyPlanContractIncentives incentivesItem)

getIncentives

@Valid
public @Valid List<EnergyPlanContractIncentives> getIncentives()

Optional list of incentives available for the contract

Returns:

incentives

setIncentives

public void setIncentives(List<EnergyPlanContractIncentives> incentives)

discounts

public EnergyPlanContract discounts(List<EnergyPlanContractDiscounts> discounts)

addDiscountsItem

public EnergyPlanContract addDiscountsItem(EnergyPlanContractDiscounts discountsItem)

getDiscounts

@Valid
public @Valid List<EnergyPlanContractDiscounts> getDiscounts()

Optional list of discounts available for the contract

Returns:

discounts

setDiscounts

public void setDiscounts(List<EnergyPlanContractDiscounts> discounts)

greenPowerCharges

public EnergyPlanContract greenPowerCharges(List<EnergyPlanContractGreenPowerCharges> greenPowerCharges)

addGreenPowerChargesItem

public EnergyPlanContract addGreenPowerChargesItem(EnergyPlanContractGreenPowerCharges greenPowerChargesItem)

getGreenPowerCharges

@Valid
public @Valid List<EnergyPlanContractGreenPowerCharges> getGreenPowerCharges()

Optional list of charges applicable to green power

Returns:

greenPowerCharges

setGreenPowerCharges

public void setGreenPowerCharges(List<EnergyPlanContractGreenPowerCharges> greenPowerCharges)

eligibility

public EnergyPlanContract eligibility(List<EnergyPlanContractEligibility> eligibility)

addEligibilityItem

public EnergyPlanContract addEligibilityItem(EnergyPlanContractEligibility eligibilityItem)

getEligibility

@Valid
public @Valid List<EnergyPlanContractEligibility> getEligibility()

Eligibility restrictions or requirements

Returns:

eligibility

setEligibility

public void setEligibility(List<EnergyPlanContractEligibility> eligibility)

fees

public EnergyPlanContract fees(List<EnergyPlanContractFees> fees)

addFeesItem

public EnergyPlanContract addFeesItem(EnergyPlanContractFees feesItem)

getFees

@Valid
public @Valid List<EnergyPlanContractFees> getFees()

An array of fees applicable to the plan

Returns:

fees

setFees

public void setFees(List<EnergyPlanContractFees> fees)

solarFeedInTariff

public EnergyPlanContract solarFeedInTariff(List<EnergyPlanContractSolarFeedInTariff> solarFeedInTariff)

addSolarFeedInTariffItem

public EnergyPlanContract addSolarFeedInTariffItem(EnergyPlanContractSolarFeedInTariff solarFeedInTariffItem)

getSolarFeedInTariff

@Valid
public @Valid List<EnergyPlanContractSolarFeedInTariff> getSolarFeedInTariff()

Array of feed in tariffs for solar power

Returns:

solarFeedInTariff

setSolarFeedInTariff

public void setSolarFeedInTariff(List<EnergyPlanContractSolarFeedInTariff> solarFeedInTariff)

tariffPeriod

public EnergyPlanContract tariffPeriod(List<EnergyPlanContractTariffPeriod> tariffPeriod)

addTariffPeriodItem

public EnergyPlanContract addTariffPeriodItem(EnergyPlanContractTariffPeriod tariffPeriodItem)

getTariffPeriod

@NotNull
 @Valid
public @NotNull @Valid List<EnergyPlanContractTariffPeriod> getTariffPeriod()

Array of tariff periods

Returns:

tariffPeriod

setTariffPeriod

public void setTariffPeriod(List<EnergyPlanContractTariffPeriod> tariffPeriod)

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