au.org.consumerdatastandards.holder.model.energy

Class EnergyConcession

java.lang.Object

au.org.consumerdatastandards.holder.model.energy.EnergyConcession

public class EnergyConcession
extends Object

EnergyConcession

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EnergyConcession.Type

Constructor Summary

Constructors

Constructor and Description
EnergyConcession()

Method Summary

Modifier and Type	Method and Description
EnergyConcession	additionalInfo(String additionalInfo)
EnergyConcession	additionalInfoUri(String additionalInfoUri)
EnergyConcession	amount(String amount)
EnergyConcession	appliedTo(String appliedTo)
EnergyConcession	discountFrequency(String discountFrequency)
EnergyConcession	displayName(String displayName)
EnergyConcession	endDate(String endDate)
boolean	equals(Object o)
String	getAdditionalInfo() Display text providing more information on the concession.
String	getAdditionalInfoUri() Optional link to additional information regarding the concession
String	getAmount() Conditional attribute for the amount of discount for the concession- required if type is FIXED_AMOUNT
String	getAppliedTo() Array of ENUM's to specify what the concession applies to.
String	getDiscountFrequency() Conditional attribute for frequency at which a concession is applied.
@NotNull String	getDisplayName() The display name of the concession
String	getEndDate() Optional end date for the application of the concession
String	getPercentage() Conditional attribute for the percentage of discount of concession - required if type is FIXED_PERCENTAGE
String	getStartDate() Optional start date for the application of the concession
@NotNull EnergyConcession.Type	getType() Indicator of the method of concession calculation
int	hashCode()
EnergyConcession	percentage(String percentage)
void	setAdditionalInfo(String additionalInfo)
void	setAdditionalInfoUri(String additionalInfoUri)
void	setAmount(String amount)
void	setAppliedTo(String appliedTo)
void	setDiscountFrequency(String discountFrequency)
void	setDisplayName(String displayName)
void	setEndDate(String endDate)
void	setPercentage(String percentage)
void	setStartDate(String startDate)
void	setType(EnergyConcession.Type type)
EnergyConcession	startDate(String startDate)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

EnergyConcession

public EnergyConcession()

Method Detail

getType

@NotNull
public @NotNull EnergyConcession.Type getType()

Indicator of the method of concession calculation

Returns:

type

setType

public void setType(EnergyConcession.Type type)

displayName

public EnergyConcession displayName(String displayName)

getDisplayName

@NotNull
public @NotNull String getDisplayName()

The display name of the concession

Returns:

displayName

setDisplayName

public void setDisplayName(String displayName)

additionalInfo

public EnergyConcession additionalInfo(String additionalInfo)

getAdditionalInfo

public String getAdditionalInfo()

Display text providing more information on the concession. Mandatory if type is VARIABLE

Returns:

additionalInfo

setAdditionalInfo

public void setAdditionalInfo(String additionalInfo)

additionalInfoUri

public EnergyConcession additionalInfoUri(String additionalInfoUri)

getAdditionalInfoUri

public String getAdditionalInfoUri()

Optional link to additional information regarding the concession

Returns:

additionalInfoUri

setAdditionalInfoUri

public void setAdditionalInfoUri(String additionalInfoUri)

startDate

public EnergyConcession startDate(String startDate)

getStartDate

public String getStartDate()

Optional start date for the application of the concession

Returns:

startDate

setStartDate

public void setStartDate(String startDate)

endDate

public EnergyConcession endDate(String endDate)

getEndDate

public String getEndDate()

Optional end date for the application of the concession

Returns:

endDate

setEndDate

public void setEndDate(String endDate)

discountFrequency

public EnergyConcession discountFrequency(String discountFrequency)

getDiscountFrequency

public String getDiscountFrequency()

Conditional attribute for frequency at which a concession is applied. Required if type is FIXED_AMOUNT or FIXED_PERCENTAGE. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)

Returns:

discountFrequency

setDiscountFrequency

public void setDiscountFrequency(String discountFrequency)

amount

public EnergyConcession amount(String amount)

getAmount

public String getAmount()

Conditional attribute for the amount of discount for the concession- required if type is FIXED_AMOUNT

Returns:

amount

setAmount

public void setAmount(String amount)

percentage

public EnergyConcession percentage(String percentage)

getPercentage

public String getPercentage()

Conditional attribute for the percentage of discount of concession - required if type is FIXED_PERCENTAGE

Returns:

percentage

setPercentage

public void setPercentage(String percentage)

appliedTo

public EnergyConcession appliedTo(String appliedTo)

getAppliedTo

public String getAppliedTo()

Array of ENUM's to specify what the concession applies to. Multiple ENUM values can be provided. If absent, USAGE is assumed

Returns:

appliedTo

setAppliedTo

public void setAppliedTo(String appliedTo)

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