au.org.consumerdatastandards.holder.model.energy.EnergyPlanControlledLoadTimeOfUseRates 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.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;

/**
 * EnergyPlanControlledLoadTimeOfUseRates
 */
@Entity(name = "e_ctrled_load_tow_rates")
public class EnergyPlanControlledLoadTimeOfUseRates {
    @Id
    @GeneratedValue(generator = "system-uuid")
    @GenericGenerator(name = "system-uuid", strategy = "uuid2")
    @JsonIgnore
    private String id;

    private String displayName;

    private String description;

    private String dailySupplyCharge;

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

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

    public String getId() {
        return id;
    }

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

    /**
     * The type of usage that the rate applies to
     */
    public enum TypeEnum {
        PEAK,
        OFF_PEAK,
        SHOULDER,
        SOLAR_SPONGE
    }

    private TypeEnum type;

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

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

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

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

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

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

    /**
     * The daily supply charge (exclusive of GST) for this controlled load tier
     *
     * @return dailySupplyCharge
     */
    @ApiModelProperty(value = "The daily supply charge (exclusive of GST) for this controlled load tier")
    public String getDailySupplyCharge() {
        return dailySupplyCharge;
    }

    public void setDailySupplyCharge(String dailySupplyCharge) {
        this.dailySupplyCharge = dailySupplyCharge;
    }

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

    public EnergyPlanControlledLoadTimeOfUseRates addRatesItem(EnergyRates 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 EnergyPlanControlledLoadTimeOfUseRates timeOfUse(List timeOfUse) {
        this.timeOfUse = timeOfUse;
        return this;
    }

    public EnergyPlanControlledLoadTimeOfUseRates addTimeOfUseItem(EnergyPlanControlledLoadTimeOfUse timeOfUseItem) {
        this.timeOfUse.add(timeOfUseItem);
        return this;
    }

    /**
     * Array of times of use
     *
     * @return timeOfUse
     */
    @ApiModelProperty(required = true, value = "Array of times of use")
    @NotNull
    @Valid
    public List getTimeOfUse() {
        return timeOfUse;
    }

    public void setTimeOfUse(List timeOfUse) {
        this.timeOfUse = timeOfUse;
    }

    public EnergyPlanControlledLoadTimeOfUseRates type(TypeEnum type) {
        this.type = type;
        return this;
    }

    /**
     * The type of usage that the rate applies to
     *
     * @return type
     */
    @ApiModelProperty(required = true, value = "The type of usage that the rate applies to")
    @NotNull
    public TypeEnum getType() {
        return type;
    }

    public void setType(TypeEnum type) {
        this.type = type;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }
        EnergyPlanControlledLoadTimeOfUseRates energyPlanControlledLoadTimeOfUseRates = (EnergyPlanControlledLoadTimeOfUseRates) o;
        return Objects.equals(this.displayName, energyPlanControlledLoadTimeOfUseRates.displayName) &&
                Objects.equals(this.description, energyPlanControlledLoadTimeOfUseRates.description) &&
                Objects.equals(this.dailySupplyCharge, energyPlanControlledLoadTimeOfUseRates.dailySupplyCharge) &&
                Objects.equals(this.rates, energyPlanControlledLoadTimeOfUseRates.rates) &&
                Objects.equals(this.timeOfUse, energyPlanControlledLoadTimeOfUseRates.timeOfUse) &&
                Objects.equals(this.type, energyPlanControlledLoadTimeOfUseRates.type);
    }

    @Override
    public int hashCode() {
        return Objects.hash(displayName, description, dailySupplyCharge, rates, timeOfUse, type);
    }

    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append("class EnergyPlanControlledLoadTimeOfUseRates {\n");
        sb.append("    displayName: ").append(toIndentedString(displayName)).append("\n");
        sb.append("    description: ").append(toIndentedString(description)).append("\n");
        sb.append("    dailySupplyCharge: ").append(toIndentedString(dailySupplyCharge)).append("\n");
        sb.append("    rates: ").append(toIndentedString(rates)).append("\n");
        sb.append("    timeOfUse: ").append(toIndentedString(timeOfUse)).append("\n");
        sb.append("    type: ").append(toIndentedString(type)).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    ");
    }
}