uk.org.openbanking.datamodel.account.Overdraft1OverdraftFeeChargeCap 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.
*/
/*
* Account and Transaction API Specification
* Swagger for Account and Transaction API Specification
*
* OpenAPI spec version: v3.1.1
* Contact: [email protected]
*
* NOTE: This class is auto generated by the swagger code generator program.
* https://github.com/swagger-api/swagger-codegen.git
* Do not edit the class manually.
*/
package uk.org.openbanking.datamodel.account;
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.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
*/
@ApiModel(description = "Details about any caps (maximum charges) that apply to a particular fee/charge")
@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-23T11:27:41.089+01:00")
public class Overdraft1OverdraftFeeChargeCap {
@JsonProperty("FeeType")
private List feeType = new ArrayList();
@JsonProperty("OverdraftControlIndicator")
private Boolean overdraftControlIndicator = null;
@JsonProperty("MinMaxType")
private MinMaxTypeEnum minMaxType = null;
@JsonProperty("FeeCapOccurrence")
private Float feeCapOccurrence = null;
@JsonProperty("FeeCapAmount")
private String feeCapAmount = null;
@JsonProperty("CappingPeriod")
private CappingPeriodEnum cappingPeriod = null;
@JsonProperty("Notes")
private List notes = null;
@JsonProperty("OtherFeeType")
private List otherFeeType = null;
public Overdraft1OverdraftFeeChargeCap feeType(List feeType) {
this.feeType = feeType;
return this;
}
public Overdraft1OverdraftFeeChargeCap addFeeTypeItem(FeeTypeEnum feeTypeItem) {
this.feeType.add(feeTypeItem);
return this;
}
/**
* Fee/charge type which is being capped
*
* @return feeType
**/
@NotNull
@Size(min = 1)
@ApiModelProperty(required = true, value = "Fee/charge type which is being capped")
public List getFeeType() {
return feeType;
}
public void setFeeType(List feeType) {
this.feeType = feeType;
}
public Overdraft1OverdraftFeeChargeCap overdraftControlIndicator(Boolean overdraftControlIndicator) {
this.overdraftControlIndicator = overdraftControlIndicator;
return this;
}
/**
* Specifies for the overdraft control feature/benefit
*
* @return overdraftControlIndicator
**/
@ApiModelProperty(value = "Specifies for the overdraft control feature/benefit")
public Boolean isOverdraftControlIndicator() {
return overdraftControlIndicator;
}
public void setOverdraftControlIndicator(Boolean overdraftControlIndicator) {
this.overdraftControlIndicator = overdraftControlIndicator;
}
public Overdraft1OverdraftFeeChargeCap minMaxType(MinMaxTypeEnum minMaxType) {
this.minMaxType = minMaxType;
return this;
}
/**
* Indicates that this is the minimum/ maximum fee/charge that can be applied by the financial institution
*
* @return minMaxType
**/
@NotNull
@ApiModelProperty(required = true, value = "Indicates that this is the minimum/ maximum fee/charge that can be applied by the financial institution")
public MinMaxTypeEnum getMinMaxType() {
return minMaxType;
}
public void setMinMaxType(MinMaxTypeEnum minMaxType) {
this.minMaxType = minMaxType;
}
public Overdraft1OverdraftFeeChargeCap feeCapOccurrence(Float feeCapOccurrence) {
this.feeCapOccurrence = feeCapOccurrence;
return this;
}
/**
* fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount
*
* @return feeCapOccurrence
**/
@ApiModelProperty(value = "fee/charges are captured dependent on the number of occurrences rather than capped at a particular amount")
public Float getFeeCapOccurrence() {
return feeCapOccurrence;
}
public void setFeeCapOccurrence(Float feeCapOccurrence) {
this.feeCapOccurrence = feeCapOccurrence;
}
public Overdraft1OverdraftFeeChargeCap feeCapAmount(String feeCapAmount) {
this.feeCapAmount = feeCapAmount;
return this;
}
/**
* Cap amount charged for a fee/charge
*
* @return feeCapAmount
**/
@Pattern(regexp = "^(-?\\d{1,14}){1}(\\.\\d{1,4}){0,1}$")
@ApiModelProperty(value = "Cap amount charged for a fee/charge")
public String getFeeCapAmount() {
return feeCapAmount;
}
public void setFeeCapAmount(String feeCapAmount) {
this.feeCapAmount = feeCapAmount;
}
public Overdraft1OverdraftFeeChargeCap cappingPeriod(CappingPeriodEnum 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 CappingPeriodEnum getCappingPeriod() {
return cappingPeriod;
}
public void setCappingPeriod(CappingPeriodEnum cappingPeriod) {
this.cappingPeriod = cappingPeriod;
}
public Overdraft1OverdraftFeeChargeCap notes(List notes) {
this.notes = notes;
return this;
}
public Overdraft1OverdraftFeeChargeCap 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 Overdraft1OverdraftFeeChargeCap otherFeeType(List otherFeeType) {
this.otherFeeType = otherFeeType;
return this;
}
public Overdraft1OverdraftFeeChargeCap addOtherFeeTypeItem(OverdraftOtherFeeType 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
**/
@Valid
@ApiModelProperty(value = "Other fee type code which is not available in the standard code set")
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;
}
Overdraft1OverdraftFeeChargeCap overdraft1OverdraftFeeChargeCap = (Overdraft1OverdraftFeeChargeCap) o;
return Objects.equals(this.feeType, overdraft1OverdraftFeeChargeCap.feeType) &&
Objects.equals(this.overdraftControlIndicator, overdraft1OverdraftFeeChargeCap.overdraftControlIndicator) &&
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, overdraftControlIndicator, minMaxType, feeCapOccurrence, feeCapAmount, cappingPeriod, notes, otherFeeType);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class Overdraft1OverdraftFeeChargeCap {\n");
sb.append(" feeType: ").append(toIndentedString(feeType)).append("\n");
sb.append(" overdraftControlIndicator: ").append(toIndentedString(overdraftControlIndicator)).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 ");
}
/**
* Overdraft fee type
*/
public enum FeeTypeEnum {
ARRANGEDOVERDRAFT("ArrangedOverdraft"),
EMERGENCYBORROWING("EmergencyBorrowing"),
BORROWINGITEM("BorrowingItem"),
OVERDRAFTRENEWAL("OverdraftRenewal"),
ANNUALREVIEW("AnnualReview"),
OVERDRAFTSETUP("OverdraftSetup"),
SURCHARGE("Surcharge"),
TEMPOVERDRAFT("TempOverdraft"),
UNAUTHORISEDBORROWING("UnauthorisedBorrowing"),
UNAUTHORISEDPAIDTRANS("UnauthorisedPaidTrans"),
OTHER("Other"),
UNAUTHORISEDUNPAIDTRANS("UnauthorisedUnpaidTrans");
private String value;
FeeTypeEnum(String value) {
this.value = value;
}
@JsonCreator
public static FeeTypeEnum fromValue(String text) {
for (FeeTypeEnum b : FeeTypeEnum.values()) {
if (String.valueOf(b.value).equals(text)) {
return b;
}
}
return null;
}
@JsonValue
public String getValue() {
return value;
}
@Override
public String toString() {
return String.valueOf(value);
}
}
/**
* Indicates that this is the minimum/ maximum fee/charge that can be applied by the financial institution
*/
public enum MinMaxTypeEnum {
MINIMUM("Minimum"),
MAXIMUM("Maximum");
private String value;
MinMaxTypeEnum(String value) {
this.value = value;
}
@JsonCreator
public static MinMaxTypeEnum fromValue(String text) {
for (MinMaxTypeEnum b : MinMaxTypeEnum.values()) {
if (String.valueOf(b.value).equals(text)) {
return b;
}
}
return null;
}
@JsonValue
public String getValue() {
return value;
}
@Override
public String toString() {
return String.valueOf(value);
}
}
/**
* Period e.g. day, week, month etc. for which the fee/charge is capped
*/
public enum CappingPeriodEnum {
ACADEMICTERM("AcademicTerm"),
DAY("Day"),
HALF_YEAR("Half Year"),
MONTH("Month"),
QUARTER("Quarter"),
WEEK("Week"),
YEAR("Year");
private String value;
CappingPeriodEnum(String value) {
this.value = value;
}
@JsonCreator
public static CappingPeriodEnum fromValue(String text) {
for (CappingPeriodEnum b : CappingPeriodEnum.values()) {
if (String.valueOf(b.value).equals(text)) {
return b;
}
}
return null;
}
@JsonValue
public String getValue() {
return value;
}
@Override
public String toString() {
return String.valueOf(value);
}
}
}