au.org.consumerdatastandards.holder.model.energy

Class EnergyPlanGeography

java.lang.Object

au.org.consumerdatastandards.holder.model.energy.EnergyPlanGeography

@Entity
public class EnergyPlanGeography
extends Object

Describes the geographical area that the plan is available for. If absent then it is assumed the plan is not geographically limited

Constructor Summary

Constructors

Constructor and Description
EnergyPlanGeography()

Method Summary

Modifier and Type	Method and Description
EnergyPlanGeography	addExcludedPostcodesItem(String excludedPostcodesItem)
EnergyPlanGeography	addIncludedPostcodesItem(String includedPostcodesItem)
boolean	equals(Object o)
EnergyPlanGeography	excludedPostcodes(List<String> excludedPostcodes)
@NotNull List<String>	getDistributors() Array of distributors for the plan.
List<String>	getExcludedPostcodes() Array of valid Australian post codes that are specifically excluded from the plan.
String	getGeographyId()
List<String>	getIncludedPostcodes() Array of valid Australian post codes that are included from the plan.
int	hashCode()
EnergyPlanGeography	includedPostcodes(List<String> includedPostcodes)
void	setDistributors(List<String> distributors)
void	setExcludedPostcodes(List<String> excludedPostcodes)
void	setGeographyId(String geographyId)
void	setIncludedPostcodes(List<String> includedPostcodes)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

EnergyPlanGeography

public EnergyPlanGeography()

Method Detail

getGeographyId

public String getGeographyId()

setGeographyId

public void setGeographyId(String geographyId)

excludedPostcodes

public EnergyPlanGeography excludedPostcodes(List<String> excludedPostcodes)

addExcludedPostcodesItem

public EnergyPlanGeography addExcludedPostcodesItem(String excludedPostcodesItem)

getExcludedPostcodes

public List<String> getExcludedPostcodes()

Array of valid Australian post codes that are specifically excluded from the plan. Each element is a single four digit postcode (e.g. 3000) or a range of postcodes defined by two four digit postcodes and a hyphen (e.g. 3000-3999)

Returns:

excludedPostcodes

setExcludedPostcodes

public void setExcludedPostcodes(List<String> excludedPostcodes)

includedPostcodes

public EnergyPlanGeography includedPostcodes(List<String> includedPostcodes)

addIncludedPostcodesItem

public EnergyPlanGeography addIncludedPostcodesItem(String includedPostcodesItem)

getIncludedPostcodes

public List<String> getIncludedPostcodes()

Array of valid Australian post codes that are included from the plan. If absent defaults to all non-excluded post codes. Each element is a single four digit postcode (e.g. 3000) or a range of postcodes defined by two four digit postcodes and a hyphen (e.g. 3000-3999)

Returns:

includedPostcodes

setIncludedPostcodes

public void setIncludedPostcodes(List<String> includedPostcodes)

getDistributors

@NotNull
public @NotNull List<String> getDistributors()

Array of distributors for the plan. Must have at least one entry

Returns:

distributors

setDistributors

public void setDistributors(List<String> distributors)

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