au.org.consumerdatastandards.holder.model.energy

Class EnergyPlanEntity

java.lang.Object

au.org.consumerdatastandards.holder.model.energy.EnergyPlanEntity

All Implemented Interfaces:

EnergyPlan

@Entity
public class EnergyPlanEntity
extends Object
implements EnergyPlan

Nested Class Summary

Nested classes/interfaces inherited from interface au.org.consumerdatastandards.holder.model.energy.EnergyPlan

EnergyPlan.CustomerTypeEnum, EnergyPlan.FuelTypeEnum, EnergyPlan.TypeEnum

Constructor Summary

Constructors

Constructor and Description
EnergyPlanEntity()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
@Valid EnergyPlanAdditionalInformation	getAdditionalInformation() Get additionalInformation
String	getApplicationUri() A link to an application web page where this plan can be applied for
@NotNull String	getBrand() The ID of the brand under which this plan is offered
@NotNull String	getBrandName() The display name of the brand under which this plan is offered
EnergyPlan.CustomerTypeEnum	getCustomerType() The type of customer that the plan is offered to.
String	getDescription() A description of the plan
String	getDisplayName() The display name of the plan
java.time.OffsetDateTime	getEffectiveFrom() The date and time from which this plan is effective (ie.
java.time.OffsetDateTime	getEffectiveTo() The date and time at which this plan will be retired and will no longer be offered.
@NotNull EnergyPlan.FuelTypeEnum	getFuelType() The fuel types covered by the plan
@Valid EnergyPlanGeography	getGeography() Get geography
@NotNull java.time.OffsetDateTime	getLastUpdated() The last date and time that the information for this plan was changed (or the creation date for the plan if it has never been altered)
@NotNull String	getPlanId() The ID of the specific plan
@NotNull EnergyPlan.TypeEnum	getType() The type of the plan
int	hashCode()
void	setAdditionalInformation(EnergyPlanAdditionalInformation additionalInformation)
void	setApplicationUri(String applicationUri)
void	setBrand(String brand)
void	setBrandName(String brandName)
void	setCustomerType(EnergyPlan.CustomerTypeEnum customerType)
void	setDescription(String description)
void	setDisplayName(String displayName)
void	setEffectiveFrom(java.time.OffsetDateTime effectiveFrom)
void	setEffectiveTo(java.time.OffsetDateTime effectiveTo)
void	setFuelType(EnergyPlan.FuelTypeEnum fuelType)
void	setGeography(EnergyPlanGeography geography)
void	setLastUpdated(java.time.OffsetDateTime lastUpdated)
void	setPlanId(String planId)
void	setType(EnergyPlan.TypeEnum type)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

EnergyPlanEntity

public EnergyPlanEntity()

Method Detail

getPlanId

@NotNull
public @NotNull String getPlanId()

The ID of the specific plan

Specified by:

getPlanId in interface EnergyPlan

Returns:

planId

setPlanId

public void setPlanId(String planId)

Specified by:

setPlanId in interface EnergyPlan

getEffectiveFrom

public java.time.OffsetDateTime getEffectiveFrom()

The date and time from which this plan is effective (ie. is available for origination). Used to enable the articulation of products to the regime before they are available for customers to originate

Specified by:

getEffectiveFrom in interface EnergyPlan

Returns:

effectiveFrom

setEffectiveFrom

public void setEffectiveFrom(java.time.OffsetDateTime effectiveFrom)

Specified by:

setEffectiveFrom in interface EnergyPlan

getEffectiveTo

public java.time.OffsetDateTime getEffectiveTo()

The date and time at which this plan will be retired and will no longer be offered. Used to enable the managed deprecation of plans

Specified by:

getEffectiveTo in interface EnergyPlan

Returns:

effectiveTo

setEffectiveTo

public void setEffectiveTo(java.time.OffsetDateTime effectiveTo)

Specified by:

setEffectiveTo in interface EnergyPlan

getLastUpdated

@NotNull
public @NotNull java.time.OffsetDateTime getLastUpdated()

The last date and time that the information for this plan was changed (or the creation date for the plan if it has never been altered)

Specified by:

getLastUpdated in interface EnergyPlan

Returns:

lastUpdated

setLastUpdated

public void setLastUpdated(java.time.OffsetDateTime lastUpdated)

Specified by:

setLastUpdated in interface EnergyPlan

getDisplayName

public String getDisplayName()

The display name of the plan

Specified by:

getDisplayName in interface EnergyPlan

Returns:

displayName

setDisplayName

public void setDisplayName(String displayName)

Specified by:

setDisplayName in interface EnergyPlan

getDescription

public String getDescription()

A description of the plan

Specified by:

getDescription in interface EnergyPlan

Returns:

description

setDescription

public void setDescription(String description)

Specified by:

setDescription in interface EnergyPlan

getType

@NotNull
public @NotNull EnergyPlan.TypeEnum getType()

The type of the plan

Specified by:

getType in interface EnergyPlan

Returns:

type

setType

public void setType(EnergyPlan.TypeEnum type)

Specified by:

setType in interface EnergyPlan

getFuelType

@NotNull
public @NotNull EnergyPlan.FuelTypeEnum getFuelType()

The fuel types covered by the plan

Specified by:

getFuelType in interface EnergyPlan

Returns:

fuelType

setFuelType

public void setFuelType(EnergyPlan.FuelTypeEnum fuelType)

Specified by:

setFuelType in interface EnergyPlan

getBrand

@NotNull
public @NotNull String getBrand()

The ID of the brand under which this plan is offered

Specified by:

getBrand in interface EnergyPlan

Returns:

brand

setBrand

public void setBrand(String brand)

Specified by:

setBrand in interface EnergyPlan

getBrandName

@NotNull
public @NotNull String getBrandName()

The display name of the brand under which this plan is offered

Specified by:

getBrandName in interface EnergyPlan

Returns:

brandName

setBrandName

public void setBrandName(String brandName)

Specified by:

setBrandName in interface EnergyPlan

getApplicationUri

public String getApplicationUri()

A link to an application web page where this plan can be applied for

Specified by:

getApplicationUri in interface EnergyPlan

Returns:

applicationUri

setApplicationUri

public void setApplicationUri(String applicationUri)

Specified by:

setApplicationUri in interface EnergyPlan

getAdditionalInformation

@Valid
public @Valid EnergyPlanAdditionalInformation getAdditionalInformation()

Get additionalInformation

Specified by:

getAdditionalInformation in interface EnergyPlan

Returns:

additionalInformation

setAdditionalInformation

public void setAdditionalInformation(EnergyPlanAdditionalInformation additionalInformation)

Specified by:

setAdditionalInformation in interface EnergyPlan

getCustomerType

public EnergyPlan.CustomerTypeEnum getCustomerType()

The type of customer that the plan is offered to. If absent then the plan is available to all customers

Specified by:

getCustomerType in interface EnergyPlan

Returns:

customerType

setCustomerType

public void setCustomerType(EnergyPlan.CustomerTypeEnum customerType)

Specified by:

setCustomerType in interface EnergyPlan

getGeography

@Valid
public @Valid EnergyPlanGeography getGeography()

Get geography

Specified by:

getGeography in interface EnergyPlan

Returns:

geography

setGeography

public void setGeography(EnergyPlanGeography geography)

Specified by:

setGeography in interface EnergyPlan

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