au.org.consumerdatastandards.holder.model.telco.TelcoPaymentScheduleDigitalWallet 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.telco;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonValue;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;

import javax.validation.constraints.NotNull;
import java.util.Objects;

/**
 * Represents a regular payment from a digital wallet. Mandatory if paymentScheduleUType is set to digitalWallet
 */
@ApiModel(description = "Represents a regular payment from a digital wallet. Mandatory if paymentScheduleUType is set to digitalWallet")
public class TelcoPaymentScheduleDigitalWallet {
    private String name;

    private String identifier;

    /**
     * The type of the digital wallet identifier
     */
    public enum TypeEnum {
        EMAIL,
        CONTACT_NAME,
        TELEPHONE
    }

    private TypeEnum type;

    /**
     * The provider of the digital wallet
     */
    public enum ProviderEnum {
        PAYPAL_AU,
        OTHER
    }

    private ProviderEnum provider;

    private String paymentFrequency;

    /**
     * The mechanism by which the payment amount is calculated.  Explanation of values are as follows:
**STATIC** - Indicates a consistent, static amount, per payment
**BALANCE** - Indicates that the outstanding balance for the account is paid per period
**CALCULATED** - Indicates that the payment amount is variable and calculated using a pre-defined algorithm
     */
    public enum CalculationTypeEnum {
        STATIC,
        BALANCE,
        CALCULATED
    }

    private CalculationTypeEnum calculationType;

    public TelcoPaymentScheduleDigitalWallet name(String name) {
        this.name = name;
        return this;
    }

    /**
     * The display name of the wallet as given by the customer, else a default value defined by the data holder
     *
     * @return name
     */
    @ApiModelProperty(required = true,
            value = "The display name of the wallet as given by the customer, else a default value defined by the data holder")
    @NotNull
    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public TelcoPaymentScheduleDigitalWallet identifier(String identifier) {
        this.identifier = identifier;
        return this;
    }

    /**
     * The identifier of the digital wallet (dependent on type)
     *
     * @return identifier
     */
    @ApiModelProperty(required = true,
            value = "The identifier of the digital wallet (dependent on type)")
    @NotNull
    public String getIdentifier() {
        return identifier;
    }

    public void setIdentifier(String identifier) {
        this.identifier = identifier;
    }

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

    /**
     * The type of the digital wallet identifier
     *
     * @return type
     */
    @ApiModelProperty(required = true,
            value = "The type of the digital wallet identifier")
    @NotNull
    public TypeEnum getType() {
        return type;
    }

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

    public TelcoPaymentScheduleDigitalWallet provider(ProviderEnum provider) {
        this.provider = provider;
        return this;
    }

    /**
     * The provider of the digital wallet
     *
     * @return provider
     */
    @ApiModelProperty(required = true, value = "The provider of the digital wallet")
    @NotNull
    public ProviderEnum getProvider() {
        return provider;
    }

    public void setProvider(ProviderEnum provider) {
        this.provider = provider;
    }

    public TelcoPaymentScheduleDigitalWallet paymentFrequency(String paymentFrequency) {
        this.paymentFrequency = paymentFrequency;
        return this;
    }

    /**
     * The frequency that payments will occur.  Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)
     *
     * @return paymentFrequency
     */
    @ApiModelProperty(required = true,
            value = "The frequency that payments will occur.  Formatted according to [ISO 8601 Durations](https://en.wikipedia.org/wiki/ISO_8601#Durations) (excludes recurrence syntax)")
    @NotNull
    public String getPaymentFrequency() {
        return paymentFrequency;
    }

    public void setPaymentFrequency(String paymentFrequency) {
        this.paymentFrequency = paymentFrequency;
    }

    public TelcoPaymentScheduleDigitalWallet calculationType(CalculationTypeEnum calculationType) {
        this.calculationType = calculationType;
        return this;
    }

    /**
     * The mechanism by which the payment amount is calculated.  Explanation of values are as follows:
**STATIC** - Indicates a consistent, static amount, per payment
**BALANCE** - Indicates that the outstanding balance for the account is paid per period
**CALCULATED** - Indicates that the payment amount is variable and calculated using a pre-defined algorithm
     *
     * @return calculationType
     */
    @ApiModelProperty(required = true,
            value = "The mechanism by which the payment amount is calculated.  Explanation of values are as follows:
**STATIC** - Indicates a consistent, static amount, per payment
**BALANCE** - Indicates that the outstanding balance for the account is paid per period
**CALCULATED** - Indicates that the payment amount is variable and calculated using a pre-defined algorithm")
    @NotNull
    public CalculationTypeEnum getCalculationType() {
        return calculationType;
    }

    public void setCalculationType(CalculationTypeEnum calculationType) {
        this.calculationType = calculationType;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }
        TelcoPaymentScheduleDigitalWallet telcoPaymentScheduleDigitalWallet = (TelcoPaymentScheduleDigitalWallet) o;
        return Objects.equals(this.name, telcoPaymentScheduleDigitalWallet.name) &&
                Objects.equals(this.identifier, telcoPaymentScheduleDigitalWallet.identifier) &&
                Objects.equals(this.type, telcoPaymentScheduleDigitalWallet.type) &&
                Objects.equals(this.provider, telcoPaymentScheduleDigitalWallet.provider) &&
                Objects.equals(this.paymentFrequency, telcoPaymentScheduleDigitalWallet.paymentFrequency) &&
                Objects.equals(this.calculationType, telcoPaymentScheduleDigitalWallet.calculationType);
    }

    @Override
    public int hashCode() {
        return Objects.hash(name, identifier, type, provider, paymentFrequency, calculationType);
    }

    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append("class TelcoPaymentScheduleDigitalWallet {\n");
        sb.append("    name: ").append(toIndentedString(name)).append("\n");
        sb.append("    identifier: ").append(toIndentedString(identifier)).append("\n");
        sb.append("    type: ").append(toIndentedString(type)).append("\n");
        sb.append("    provider: ").append(toIndentedString(provider)).append("\n");
        sb.append("    paymentFrequency: ").append(toIndentedString(paymentFrequency)).append("\n");
        sb.append("    calculationType: ").append(toIndentedString(calculationType)).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    ");
    }
}