au.org.consumerdatastandards.holder.model.energy.EnergyPlanContractSingleRate Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of data-holder Show documentation
CDS sample data holder
The newest version!
package au.org.consumerdatastandards.holder.model.energy;

import com.fasterxml.jackson.annotation.JsonIgnore;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import org.hibernate.annotations.GenericGenerator;

import javax.persistence.CascadeType;
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.Id;
import javax.persistence.OneToMany;
import javax.validation.Valid;
import javax.validation.constraints.NotNull;
import java.util.ArrayList;
import java.util.List;
import java.util.Objects;

/**
 * Object representing a single rate.  Required if rateBlockUType is singleRate
 */
@ApiModel(description = "Object representing a single rate.  Required if rateBlockUType is singleRate")
@Entity
public class EnergyPlanContractSingleRate {
    @Id
    @GeneratedValue(generator = "system-uuid")
    @GenericGenerator(name = "system-uuid", strategy = "uuid2")
    @JsonIgnore
    private String id;

    private String displayName;

    private String description;

    private String generalUnitPrice;

    @Valid
    @OneToMany(cascade = CascadeType.ALL)
    private List rates = new ArrayList<>();

    private String period;

    public String getId() {
        return id;
    }

    public void setId(String id) {
        this.id = id;
    }

    public EnergyPlanContractSingleRate displayName(String displayName) {
        this.displayName = displayName;
        return this;
    }

    /**
     * Display name of the rate
     *
     * @return displayName
     */
    @ApiModelProperty(required = true, value = "Display name of the rate")
    @NotNull
    public String getDisplayName() {
        return displayName;
    }

    public void setDisplayName(String displayName) {
        this.displayName = displayName;
    }

    public EnergyPlanContractSingleRate description(String description) {
        this.description = description;
        return this;
    }

    /**
     * Description of the rate
     *
     * @return description
     */
    @ApiModelProperty(value = "Description of the rate")
    public String getDescription() {
        return description;
    }

    public void setDescription(String description) {
        this.description = description;
    }

    public EnergyPlanContractSingleRate generalUnitPrice(String generalUnitPrice) {
        this.generalUnitPrice = generalUnitPrice;
        return this;
    }

    /**
     * The block rate (unit price) for any usage above the included fixed usage, in dollars per kWh inclusive of GST.  Only required if pricingModel field is ‘QUOTA’
     *
     * @return generalUnitPrice
     */
    @ApiModelProperty(value = "The block rate (unit price) for any usage above the included fixed usage, in dollars per kWh inclusive of GST.  Only required if pricingModel field is ‘QUOTA’")
    public String getGeneralUnitPrice() {
        return generalUnitPrice;
    }

    public void setGeneralUnitPrice(String generalUnitPrice) {
        this.generalUnitPrice = generalUnitPrice;
    }

    public EnergyPlanContractSingleRate rates(List rates) {
        this.rates = rates;
        return this;
    }

    public EnergyPlanContractSingleRate addRatesItem(EnergyPlanContractSingleRateRates ratesItem) {
        this.rates.add(ratesItem);
        return this;
    }

    /**
     * Array of controlled load rates in order of usage volume
     *
     * @return rates
     */
    @ApiModelProperty(required = true, value = "Array of controlled load rates in order of usage volume")
    @NotNull
    @Valid
    public List getRates() {
        return rates;
    }

    public void setRates(List rates) {
        this.rates = rates;
    }

    public EnergyPlanContractSingleRate period(String period) {
        this.period = period;
        return this;
    }

    /**
     * Usage period for which the block rate applies. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)
     *
     * @return period
     */
    @ApiModelProperty(value = "Usage period for which the block rate applies. Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)")
    public String getPeriod() {
        return period;
    }

    public void setPeriod(String period) {
        this.period = period;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }
        EnergyPlanContractSingleRate energyPlanContractSingleRate = (EnergyPlanContractSingleRate) o;
        return Objects.equals(this.displayName, energyPlanContractSingleRate.displayName) &&
                Objects.equals(this.description, energyPlanContractSingleRate.description) &&
                Objects.equals(this.generalUnitPrice, energyPlanContractSingleRate.generalUnitPrice) &&
                Objects.equals(this.rates, energyPlanContractSingleRate.rates) &&
                Objects.equals(this.period, energyPlanContractSingleRate.period);
    }

    @Override
    public int hashCode() {
        return Objects.hash(displayName, description, generalUnitPrice, rates, period);
    }

    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append("class EnergyPlanContractSingleRate {\n");
        sb.append("    displayName: ").append(toIndentedString(displayName)).append("\n");
        sb.append("    description: ").append(toIndentedString(description)).append("\n");
        sb.append("    generalUnitPrice: ").append(toIndentedString(generalUnitPrice)).append("\n");
        sb.append("    rates: ").append(toIndentedString(rates)).append("\n");
        sb.append("    period: ").append(toIndentedString(period)).append("\n");
        sb.append("}");
        return sb.toString();
    }

    /**
     * Convert the given object to string with each line indented by 4 spaces
     * (except the first line).
     */
    private String toIndentedString(Object o) {
        if (o == null) {
            return "null";
        }
        return o.toString().replace("\n", "\n    ");
    }
}