uk.org.openbanking.datamodel.account.OBOverdraftFeeChargeCap1 Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of openbanking-sdk Show documentation
Show all versions of openbanking-sdk Show documentation
A Java SDK to help implementing the Open Banking standard : https://www.openbanking.org.uk/read-write-apis/
/**
*
* The contents of this file are subject to the terms of the Common Development and
* Distribution License (the License). You may not use this file except in compliance with the
* License.
*
* You can obtain a copy of the License at https://forgerock.org/cddlv1-0/. See the License for the
* specific language governing permission and limitations under the License.
*
* When distributing Covered Software, include this CDDL Header Notice in each file and include
* the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
* Header, with the fields enclosed by brackets [] replaced by your own identifying
* information: "Portions copyright [year] [name of copyright owner]".
*
* Copyright 2019 ForgeRock AS.
*/
package uk.org.openbanking.datamodel.account;
import com.fasterxml.jackson.annotation.JsonProperty;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import org.springframework.validation.annotation.Validated;
import javax.validation.Valid;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Pattern;
import javax.validation.constraints.Size;
import java.util.ArrayList;
import java.util.List;
import java.util.Objects;
/**
* Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate.
*/
@ApiModel(description = "Details about any caps (maximum charges) that apply to a particular fee/charge. Capping can either be based on an amount (in gbp), an amount (in items) or a rate.")
@Validated
@javax.annotation.Generated(value = "io.swagger.codegen.languages.SpringCodegen", date = "2018-06-25T23:06:46.214+01:00")
public class OBOverdraftFeeChargeCap1 {
@JsonProperty("FeeType")
@Valid
private List feeType = new ArrayList();
@JsonProperty("MinMaxType")
private OBMinMaxType1Code minMaxType = null;
@JsonProperty("FeeCapOccurrence")
private Float feeCapOccurrence = null;
@JsonProperty("FeeCapAmount")
private String feeCapAmount = null;
@JsonProperty("CappingPeriod")
private OBPeriod1Code cappingPeriod = null;
@JsonProperty("Notes")
@Valid
private List notes = null;
@JsonProperty("OtherFeeType")
@Valid
private List otherFeeType = null;
public OBOverdraftFeeChargeCap1 feeType(List feeType) {
this.feeType = feeType;
return this;
}
public OBOverdraftFeeChargeCap1 addFeeTypeItem(OBOverdraftFeeType1Code feeTypeItem) {
this.feeType.add(feeTypeItem);
return this;
}
/**
* Fee/charge type which is being capped
* @return feeType
**/
@ApiModelProperty(required = true, value = "Fee/charge type which is being capped")
@NotNull
@Size(min=1)
public List getFeeType() {
return feeType;
}
public void setFeeType(List feeType) {
this.feeType = feeType;
}
public OBOverdraftFeeChargeCap1 minMaxType(OBMinMaxType1Code minMaxType) {
this.minMaxType = minMaxType;
return this;
}
/**
* Min Max type
* @return minMaxType
**/
@ApiModelProperty(required = true, value = "Min Max type")
@NotNull
public OBMinMaxType1Code getMinMaxType() {
return minMaxType;
}
public void setMinMaxType(OBMinMaxType1Code minMaxType) {
this.minMaxType = minMaxType;
}
public OBOverdraftFeeChargeCap1 feeCapOccurrence(Float feeCapOccurrence) {
this.feeCapOccurrence = feeCapOccurrence;
return this;
}
/**
* Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it’s part of a government scheme, or whether the rate may vary dependent on the applicant’s circumstances.
* @return feeCapOccurrence
**/
@ApiModelProperty(value = "Indicates whether the advertised overdraft rate is guaranteed to be offered to a borrower by the bank e.g. if it’s part of a government scheme, or whether the rate may vary dependent on the applicant’s circumstances.")
public Float getFeeCapOccurrence() {
return feeCapOccurrence;
}
public void setFeeCapOccurrence(Float feeCapOccurrence) {
this.feeCapOccurrence = feeCapOccurrence;
}
public OBOverdraftFeeChargeCap1 feeCapAmount(String feeCapAmount) {
this.feeCapAmount = feeCapAmount;
return this;
}
/**
* Cap amount charged for a fee/charge
* @return feeCapAmount
**/
@ApiModelProperty(value = "Cap amount charged for a fee/charge")
@Pattern(regexp="^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$")
public String getFeeCapAmount() {
return feeCapAmount;
}
public void setFeeCapAmount(String feeCapAmount) {
this.feeCapAmount = feeCapAmount;
}
public OBOverdraftFeeChargeCap1 cappingPeriod(OBPeriod1Code cappingPeriod) {
this.cappingPeriod = cappingPeriod;
return this;
}
/**
* Period e.g. day, week, month etc. for which the fee/charge is capped
* @return cappingPeriod
**/
@ApiModelProperty(value = "Period e.g. day, week, month etc. for which the fee/charge is capped")
public OBPeriod1Code getCappingPeriod() {
return cappingPeriod;
}
public void setCappingPeriod(OBPeriod1Code cappingPeriod) {
this.cappingPeriod = cappingPeriod;
}
public OBOverdraftFeeChargeCap1 notes(List notes) {
this.notes = notes;
return this;
}
public OBOverdraftFeeChargeCap1 addNotesItem(String notesItem) {
if (this.notes == null) {
this.notes = new ArrayList();
}
this.notes.add(notesItem);
return this;
}
/**
* Notes related to Overdraft fee charge cap
* @return notes
**/
@ApiModelProperty(value = "Notes related to Overdraft fee charge cap")
public List getNotes() {
return notes;
}
public void setNotes(List notes) {
this.notes = notes;
}
public OBOverdraftFeeChargeCap1 otherFeeType(List otherFeeType) {
this.otherFeeType = otherFeeType;
return this;
}
public OBOverdraftFeeChargeCap1 addOtherFeeTypeItem(OBOtherCodeType1 otherFeeTypeItem) {
if (this.otherFeeType == null) {
this.otherFeeType = new ArrayList();
}
this.otherFeeType.add(otherFeeTypeItem);
return this;
}
/**
* Other fee type code which is not available in the standard code set
* @return otherFeeType
**/
@ApiModelProperty(value = "Other fee type code which is not available in the standard code set")
@Valid
public List getOtherFeeType() {
return otherFeeType;
}
public void setOtherFeeType(List otherFeeType) {
this.otherFeeType = otherFeeType;
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
OBOverdraftFeeChargeCap1 overdraft1OverdraftFeeChargeCap = (OBOverdraftFeeChargeCap1) o;
return Objects.equals(this.feeType, overdraft1OverdraftFeeChargeCap.feeType) &&
Objects.equals(this.minMaxType, overdraft1OverdraftFeeChargeCap.minMaxType) &&
Objects.equals(this.feeCapOccurrence, overdraft1OverdraftFeeChargeCap.feeCapOccurrence) &&
Objects.equals(this.feeCapAmount, overdraft1OverdraftFeeChargeCap.feeCapAmount) &&
Objects.equals(this.cappingPeriod, overdraft1OverdraftFeeChargeCap.cappingPeriod) &&
Objects.equals(this.notes, overdraft1OverdraftFeeChargeCap.notes) &&
Objects.equals(this.otherFeeType, overdraft1OverdraftFeeChargeCap.otherFeeType);
}
@Override
public int hashCode() {
return Objects.hash(feeType, minMaxType, feeCapOccurrence, feeCapAmount, cappingPeriod, notes, otherFeeType);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class OBOverdraftFeeChargeCap1 {\n");
sb.append(" feeType: ").append(toIndentedString(feeType)).append("\n");
sb.append(" minMaxType: ").append(toIndentedString(minMaxType)).append("\n");
sb.append(" feeCapOccurrence: ").append(toIndentedString(feeCapOccurrence)).append("\n");
sb.append(" feeCapAmount: ").append(toIndentedString(feeCapAmount)).append("\n");
sb.append(" cappingPeriod: ").append(toIndentedString(cappingPeriod)).append("\n");
sb.append(" notes: ").append(toIndentedString(notes)).append("\n");
sb.append(" otherFeeType: ").append(toIndentedString(otherFeeType)).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 ");
}
}