EnergyPlanContractFull (Data Holder 1.22.0 API)

java.lang.Object
- au.org.consumerdatastandards.holder.model.energy.EnergyPlanContractFull

@Entity
public class EnergyPlanContractFull
extends Object

EnergyPlanContractFull

Nested Class Summary

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

Constructor Summary

Constructors
Constructor and Description

EnergyPlanContractFull()

Constructors
Constructor and Description
`EnergyPlanContractFull()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`EnergyPlanContractFull`	`addBillFrequencyItem(String billFrequencyItem)`
`EnergyPlanContractFull`	`addDiscountsItem(EnergyPlanContractDiscounts discountsItem)`
`EnergyPlanContractFull`	`addEligibilityItem(EnergyPlanContractEligibility eligibilityItem)`
`EnergyPlanContractFull`	`addFeesItem(EnergyPlanContractFees feesItem)`
`EnergyPlanContractFull`	`addGreenPowerChargesItem(EnergyPlanContractGreenPowerCharges greenPowerChargesItem)`
`EnergyPlanContractFull`	`addIncentivesItem(EnergyPlanContractIncentives incentivesItem)`
`EnergyPlanContractFull`	`additionalFeeInformation(String additionalFeeInformation)`
`EnergyPlanContractFull`	`addMeterTypesItem(String meterTypesItem)`
`EnergyPlanContractFull`	`addPaymentOptionItem(EnergyPlanContractFull.PaymentOptionEnum paymentOptionItem)`
`EnergyPlanContractFull`	`addSolarFeedInTariffItem(EnergyPlanContractSolarFeedInTariff solarFeedInTariffItem)`
`EnergyPlanContractFull`	`addTariffPeriodItem(EnergyPlanContractTariffPeriod tariffPeriodItem)`
`EnergyPlanContractFull`	`benefitPeriod(String benefitPeriod)`
`EnergyPlanContractFull`	`billFrequency(List<String> billFrequency)`
`EnergyPlanContractFull`	`controlledLoad(List<EnergyPlanControlledLoad> controlledLoad)`
`EnergyPlanContractFull`	`coolingOffDays(Integer coolingOffDays)`
`EnergyPlanContractFull`	`discounts(List<EnergyPlanContractDiscounts> discounts)`
`EnergyPlanContractFull`	`eligibility(List<EnergyPlanContractEligibility> eligibility)`
`boolean`	`equals(Object o)`
`EnergyPlanContractFull`	`fees(List<EnergyPlanContractFees> fees)`
`String`	`getAdditionalFeeInformation()` Free text field containing additional information of the fees for this contract
`String`	`getBenefitPeriod()` Description of the benefit period.
`@NotNull List<String>`	`getBillFrequency()` An array of the available billing schedules for this contract.
`List<EnergyPlanControlledLoad>`	`getControlledLoad()` Get controlledLoad
`Integer`	`getCoolingOffDays()` Number of days in the cooling off period for the contract.
`@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
`String`	`getId()`
`@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
`List<String>`	`getMeterTypes()` An array of the meter types that this contract is available for
`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<EnergyPlanContractFull.PaymentOptionEnum>`	`getPaymentOption()` Payment options for this contract
`@NotNull EnergyPlanContractFull.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
`String`	`getTerms()` Free text description of the terms for the contract
`EnergyPlanContractFull.TermTypeEnum`	`getTermType()` The term for the contract.
`EnergyPlanContractFull.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.
`EnergyPlanContractFull`	`greenPowerCharges(List<EnergyPlanContractGreenPowerCharges> greenPowerCharges)`
`int`	`hashCode()`
`EnergyPlanContractFull`	`incentives(List<EnergyPlanContractIncentives> incentives)`
`EnergyPlanContractFull`	`intrinsicGreenPower(EnergyPlanContractIntrinsicGreenPower intrinsicGreenPower)`
`EnergyPlanContractFull`	`isFixed(Boolean isFixed)`
`EnergyPlanContractFull`	`meterTypes(List<String> meterTypes)`
`EnergyPlanContractFull`	`onExpiryDescription(String onExpiryDescription)`
`EnergyPlanContractFull`	`paymentOption(List<EnergyPlanContractFull.PaymentOptionEnum> paymentOption)`
`EnergyPlanContractFull`	`pricingModel(EnergyPlanContractFull.PricingModelEnum pricingModel)`
`void`	`setAdditionalFeeInformation(String additionalFeeInformation)`
`void`	`setBenefitPeriod(String benefitPeriod)`
`void`	`setBillFrequency(List<String> billFrequency)`
`void`	`setControlledLoad(List<EnergyPlanControlledLoad> controlledLoad)`
`void`	`setCoolingOffDays(Integer coolingOffDays)`
`void`	`setDiscounts(List<EnergyPlanContractDiscounts> discounts)`
`void`	`setEligibility(List<EnergyPlanContractEligibility> eligibility)`
`void`	`setFees(List<EnergyPlanContractFees> fees)`
`void`	`setGreenPowerCharges(List<EnergyPlanContractGreenPowerCharges> greenPowerCharges)`
`void`	`setId(String id)`
`void`	`setIncentives(List<EnergyPlanContractIncentives> incentives)`
`void`	`setIntrinsicGreenPower(EnergyPlanContractIntrinsicGreenPower intrinsicGreenPower)`
`void`	`setIsFixed(Boolean isFixed)`
`void`	`setMeterTypes(List<String> meterTypes)`
`void`	`setOnExpiryDescription(String onExpiryDescription)`
`void`	`setPaymentOption(List<EnergyPlanContractFull.PaymentOptionEnum> paymentOption)`
`void`	`setPricingModel(EnergyPlanContractFull.PricingModelEnum pricingModel)`
`void`	`setSolarFeedInTariff(List<EnergyPlanContractSolarFeedInTariff> solarFeedInTariff)`
`void`	`setTariffPeriod(List<EnergyPlanContractTariffPeriod> tariffPeriod)`
`void`	`setTerms(String terms)`
`void`	`setTermType(EnergyPlanContractFull.TermTypeEnum termType)`
`void`	`setTimeZone(EnergyPlanContractFull.TimeZoneEnum timeZone)`
`void`	`setVariation(String variation)`
`EnergyPlanContractFull`	`solarFeedInTariff(List<EnergyPlanContractSolarFeedInTariff> solarFeedInTariff)`
`EnergyPlanContractFull`	`tariffPeriod(List<EnergyPlanContractTariffPeriod> tariffPeriod)`
`EnergyPlanContractFull`	`terms(String terms)`
`EnergyPlanContractFull`	`termType(EnergyPlanContractFull.TermTypeEnum termType)`
`EnergyPlanContractFull`	`timeZone(EnergyPlanContractFull.TimeZoneEnum timeZone)`
`String`	`toString()`
`EnergyPlanContractFull`	`variation(String variation)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail
- EnergyPlanContractFull
```
public EnergyPlanContractFull()
```

Method Detail

getId
```
public String getId()
```

setId
```
public void setId(String id)
```

additionalFeeInformation

public EnergyPlanContractFull 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 EnergyPlanContractFull pricingModel(EnergyPlanContractFull.PricingModelEnum pricingModel)

getPricingModel
```
@NotNull
public @NotNull EnergyPlanContractFull.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(EnergyPlanContractFull.PricingModelEnum pricingModel)

timeZone

public EnergyPlanContractFull timeZone(EnergyPlanContractFull.TimeZoneEnum timeZone)

getTimeZone
```
public EnergyPlanContractFull.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(EnergyPlanContractFull.TimeZoneEnum timeZone)

isFixed

public EnergyPlanContractFull 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 EnergyPlanContractFull 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 EnergyPlanContractFull 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 EnergyPlanContractFull paymentOption(List<EnergyPlanContractFull.PaymentOptionEnum> paymentOption)

addPaymentOptionItem

public EnergyPlanContractFull addPaymentOptionItem(EnergyPlanContractFull.PaymentOptionEnum paymentOptionItem)

getPaymentOption

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

Payment options for this contract

Returns:: paymentOption

setPaymentOption

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

intrinsicGreenPower

public EnergyPlanContractFull intrinsicGreenPower(EnergyPlanContractIntrinsicGreenPower intrinsicGreenPower)

getIntrinsicGreenPower

@Valid
public @Valid EnergyPlanContractIntrinsicGreenPower getIntrinsicGreenPower()

Get intrinsicGreenPower

Returns:: intrinsicGreenPower

setIntrinsicGreenPower

public void setIntrinsicGreenPower(EnergyPlanContractIntrinsicGreenPower intrinsicGreenPower)

controlledLoad

public EnergyPlanContractFull controlledLoad(List<EnergyPlanControlledLoad> controlledLoad)

getControlledLoad

public List<EnergyPlanControlledLoad> getControlledLoad()

Get controlledLoad

Returns:: controlledLoad

setControlledLoad

public void setControlledLoad(List<EnergyPlanControlledLoad> controlledLoad)

incentives

public EnergyPlanContractFull incentives(List<EnergyPlanContractIncentives> incentives)

addIncentivesItem

public EnergyPlanContractFull 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 EnergyPlanContractFull discounts(List<EnergyPlanContractDiscounts> discounts)

addDiscountsItem

public EnergyPlanContractFull 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 EnergyPlanContractFull greenPowerCharges(List<EnergyPlanContractGreenPowerCharges> greenPowerCharges)

addGreenPowerChargesItem

public EnergyPlanContractFull 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 EnergyPlanContractFull eligibility(List<EnergyPlanContractEligibility> eligibility)

addEligibilityItem

public EnergyPlanContractFull 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 EnergyPlanContractFull fees(List<EnergyPlanContractFees> fees)

addFeesItem

public EnergyPlanContractFull 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 EnergyPlanContractFull solarFeedInTariff(List<EnergyPlanContractSolarFeedInTariff> solarFeedInTariff)

addSolarFeedInTariffItem

public EnergyPlanContractFull 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 EnergyPlanContractFull tariffPeriod(List<EnergyPlanContractTariffPeriod> tariffPeriod)

addTariffPeriodItem

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

termType

public EnergyPlanContractFull termType(EnergyPlanContractFull.TermTypeEnum termType)

getTermType
```
public EnergyPlanContractFull.TermTypeEnum getTermType()
```
The term for the contract. If absent assumes no specified term

Returns:

termType

setTermType

public void setTermType(EnergyPlanContractFull.TermTypeEnum termType)

benefitPeriod

public EnergyPlanContractFull benefitPeriod(String benefitPeriod)

getBenefitPeriod
```
public String getBenefitPeriod()
```
Description of the benefit period. Should only be present if termType has the value ONGOING

Returns:

benefitPeriod

setBenefitPeriod

public void setBenefitPeriod(String benefitPeriod)

terms

public EnergyPlanContractFull terms(String terms)

getTerms
```
public String getTerms()
```
Free text description of the terms for the contract

Returns:

terms

setTerms
```
public void setTerms(String terms)
```

meterTypes

public EnergyPlanContractFull meterTypes(List<String> meterTypes)

addMeterTypesItem

public EnergyPlanContractFull addMeterTypesItem(String meterTypesItem)

getMeterTypes
```
public List<String> getMeterTypes()
```
An array of the meter types that this contract is available for

Returns:

meterTypes

setMeterTypes

public void setMeterTypes(List<String> meterTypes)

coolingOffDays

public EnergyPlanContractFull coolingOffDays(Integer coolingOffDays)

getCoolingOffDays
```
public Integer getCoolingOffDays()
```
Number of days in the cooling off period for the contract. Mandatory for plans with type of MARKET

Returns:

coolingOffDays

setCoolingOffDays

public void setCoolingOffDays(Integer coolingOffDays)

billFrequency

public EnergyPlanContractFull billFrequency(List<String> billFrequency)

addBillFrequencyItem

public EnergyPlanContractFull addBillFrequencyItem(String billFrequencyItem)

getBillFrequency
```
@NotNull
public @NotNull List<String> getBillFrequency()
```
An array of the available billing schedules for this contract. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)

Returns:

billFrequency

setBillFrequency

public void setBillFrequency(List<String> billFrequency)

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

Class EnergyPlanContractFull