au.org.consumerdatastandards.holder.model.energy

Interface EnergyPlan

All Known Subinterfaces:

EnergyPlanDetail

All Known Implementing Classes:

EnergyPlanDetailEntity, EnergyPlanEntity

public interface EnergyPlan

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	EnergyPlan.CustomerTypeEnum The type of customer that the plan is offered to.
static class	EnergyPlan.FuelTypeEnum The fuel types covered by the plan
static class	EnergyPlan.TypeEnum The type of the plan

Method Summary

Modifier and Type	Method and Description
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
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
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)

Method Detail

getPlanId

@NotNull
@NotNull String getPlanId()

The ID of the specific plan

Returns:

planId

setPlanId

void setPlanId(String planId)

getEffectiveFrom

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

Returns:

effectiveFrom

setEffectiveFrom

void setEffectiveFrom(java.time.OffsetDateTime effectiveFrom)

getEffectiveTo

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

Returns:

effectiveTo

setEffectiveTo

void setEffectiveTo(java.time.OffsetDateTime effectiveTo)

getLastUpdated

@NotNull
@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)

Returns:

lastUpdated

setLastUpdated

void setLastUpdated(java.time.OffsetDateTime lastUpdated)

getDisplayName

String getDisplayName()

The display name of the plan

Returns:

displayName

setDisplayName

void setDisplayName(String displayName)

getDescription

String getDescription()

A description of the plan

Returns:

description

setDescription

void setDescription(String description)

getType

@NotNull
@NotNull EnergyPlan.TypeEnum getType()

The type of the plan

Returns:

type

setType

void setType(EnergyPlan.TypeEnum type)

getFuelType

@NotNull
@NotNull EnergyPlan.FuelTypeEnum getFuelType()

The fuel types covered by the plan

Returns:

fuelType

setFuelType

void setFuelType(EnergyPlan.FuelTypeEnum fuelType)

getBrand

@NotNull
@NotNull String getBrand()

The ID of the brand under which this plan is offered

Returns:

brand

setBrand

void setBrand(String brand)

getBrandName

@NotNull
@NotNull String getBrandName()

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

Returns:

brandName

setBrandName

void setBrandName(String brandName)

getApplicationUri

String getApplicationUri()

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

Returns:

applicationUri

setApplicationUri

void setApplicationUri(String applicationUri)

getAdditionalInformation

EnergyPlanAdditionalInformation getAdditionalInformation()

Get additionalInformation

Returns:

additionalInformation

setAdditionalInformation

void setAdditionalInformation(EnergyPlanAdditionalInformation additionalInformation)

getCustomerType

EnergyPlan.CustomerTypeEnum getCustomerType()

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

Returns:

customerType

setCustomerType

void setCustomerType(EnergyPlan.CustomerTypeEnum customerType)

getGeography

EnergyPlanGeography getGeography()

Get geography

Returns:

geography

setGeography

void setGeography(EnergyPlanGeography geography)