FINERACT-2354: Re-aging: Interest handling configuration

Author: Jose Alberto Hernandez

fineract-core/src/main/java/org/apache/fineract/infrastructure/core/data/DataValidatorBuilder.java

@@ -983,7 +983,7 @@ public DataValidatorBuilder validateDateAfter(final LocalDate date) {
             final LocalDate dateVal = (LocalDate) this.value;
             if (DateUtils.isAfter(date, dateVal)) {
                 String validationErrorCode = "validation.msg." + this.resource + "." + this.parameter + ".is.less.than.date";
-                String defaultEnglishMessage = "The parameter `" + this.parameter + "` must be greater than the provided date" + date;
+                String defaultEnglishMessage = "The parameter `" + this.parameter + "` must be greater than the provided date " + date;
                 final ApiParameterError error = ApiParameterError.parameterError(validationErrorCode, defaultEnglishMessage, this.parameter,
                         dateVal, date);
                 this.dataValidationErrors.add(error);

fineract-core/src/main/java/org/apache/fineract/portfolio/common/service/CommonEnumerations.java

@@ -28,6 +28,9 @@
 
 public final class CommonEnumerations {
 
+    public static final List<PeriodFrequencyType> BASIC_PERIOD_FREQUENCY_TYPES = List.of(PeriodFrequencyType.DAYS,
+            PeriodFrequencyType.WEEKS, PeriodFrequencyType.MONTHS, PeriodFrequencyType.YEARS);
+
     private CommonEnumerations() {
 
     }

fineract-loan/src/main/java/org/apache/fineract/portfolio/loanaccount/api/LoanApiConstants.java

@@ -140,6 +140,8 @@ public interface LoanApiConstants {
     String WRITEOFFREASONS = "WriteOffReasons";
     // loan charge-off
     String CHARGE_OFF_REASONS = "ChargeOffReasons";
+    // loan ReAge
+    String REAGE_REASONS = "ReAgeReasons";
     // fore closure constants
     String transactionDateParamName = "transactionDate";
     String noteParamName = "note";
@@ -183,6 +185,7 @@ public interface LoanApiConstants {
     String UNDO_CONTRACT_TERMINATION_COMMAND = "undoContractTermination";
     String BUY_DOWN_FEE_COMMAND = "buyDownFee";
     String BUY_DOWN_FEE_ADJUSTMENT_COMMAND = "buyDownFeeAdjustment";
+    String REAGE_COMMAND = "reAge";
 
     // Data Validator names
     String LOAN_FRAUD_DATAVALIDATOR_PREFIX = "loans.fraud";

fineract-loan/src/main/java/org/apache/fineract/portfolio/loanaccount/api/LoanReAgingApiConstants.java

@@ -28,4 +28,7 @@ public interface LoanReAgingApiConstants {
     String frequencyNumber = "frequencyNumber";
     String startDate = "startDate";
     String numberOfInstallments = "numberOfInstallments";
+
+    String reAgeInterestHandlingParamName = "reAgeInterestHandling";
+    String reasonCodeValueIdParamName = "reasonCodeValueId";
 }

fineract-loan/src/main/java/org/apache/fineract/portfolio/loanaccount/api/LoanTransactionsApiResourceSwagger.java

@@ -368,6 +368,11 @@ private PostLoansLoanIdTransactionsRequest() {}
         public String startDate;
         @Schema(example = "numberOfInstallments")
         public Integer numberOfInstallments;
+        @Schema(example = "DEFAULT")
+        public String reAgeInterestHandling;
+        @Schema(example = "1")
+        public Long reasonCodeValueId;
+
         // command=reAge END
         @Schema(description = "Optional. Controls whether Interest Refund transaction should be created for this refund. If not provided, loan product config is used.", example = "false")
         public Boolean interestRefundCalculation;

fineract-loan/src/main/java/org/apache/fineract/portfolio/loanaccount/data/LoanTransactionData.java

@@ -30,9 +30,11 @@
 import lombok.Getter;
 import lombok.Setter;
 import org.apache.fineract.infrastructure.codes.data.CodeValueData;
+import org.apache.fineract.infrastructure.core.data.StringEnumOptionData;
 import org.apache.fineract.infrastructure.core.domain.ExternalId;
 import org.apache.fineract.organisation.monetary.data.CurrencyData;
 import org.apache.fineract.portfolio.account.data.AccountTransferData;
+import org.apache.fineract.portfolio.common.domain.PeriodFrequencyType;
 import org.apache.fineract.portfolio.paymentdetail.data.PaymentDetailData;
 import org.apache.fineract.portfolio.paymenttype.data.PaymentTypeData;
 
@@ -116,6 +118,10 @@ public class LoanTransactionData implements Serializable {
     private Collection<CodeValueData> classificationOptions = null;
     private CodeValueData classification;
 
+    private Collection<CodeValueData> reAgeReasonOptions = null;
+    private Collection<PeriodFrequencyType> periodFrequencyOptions = null;
+    private Collection<StringEnumOptionData> reAgeInterestHandlingOptions = null;
+
     public static LoanTransactionData importInstance(BigDecimal repaymentAmount, LocalDate lastRepaymentDate, Long repaymentTypeId,
             Integer rowIndex, String locale, String dateFormat) {
         return LoanTransactionData.builder().transactionAmount(repaymentAmount).transactionDate(lastRepaymentDate)

fineract-loan/src/main/java/org/apache/fineract/portfolio/loanaccount/domain/reaging/LoanReAgeInterestHandlingType.java

@@ -0,0 +1,47 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.fineract.portfolio.loanaccount.domain.reaging;
+
+import java.util.Arrays;
+import java.util.List;
+import lombok.Getter;
+import lombok.RequiredArgsConstructor;
+import org.apache.fineract.infrastructure.core.data.StringEnumOptionData;
+
+@Getter
+@RequiredArgsConstructor
+public enum LoanReAgeInterestHandlingType {
+
+    DEFAULT("loanReAgeInterestHandlingType.default", "Default"), //
+    WAIVE_INTEREST("loanReAgeInterestHandlingType.waiveInterest", "Waive Interest"), //
+    EQUAL_AMORTIZATION("loanReAgeInterestHandlingType.equalAmortization", "Equal Amortization of Outstanding amount"), //
+    ;
+
+    private final String code;
+    private final String humanReadableName;
+
+    public static List<StringEnumOptionData> getValuesAsEnumOptionDataList() {
+        return Arrays.stream(values()).map(v -> new StringEnumOptionData(v.name(), v.getCode(), v.getHumanReadableName())).toList();
+    }
+
+    public StringEnumOptionData asEnumOptionData() {
+        return new StringEnumOptionData(name(), getCode(), getHumanReadableName());
+    }
+
+}

fineract-loan/src/main/java/org/apache/fineract/portfolio/loanaccount/domain/reaging/LoanReAgeParameter.java

@@ -23,11 +23,13 @@
 import jakarta.persistence.EnumType;
 import jakarta.persistence.Enumerated;
 import jakarta.persistence.JoinColumn;
+import jakarta.persistence.ManyToOne;
 import jakarta.persistence.OneToOne;
 import jakarta.persistence.Table;
 import java.time.LocalDate;
 import lombok.AllArgsConstructor;
 import lombok.Getter;
+import org.apache.fineract.infrastructure.codes.domain.CodeValue;
 import org.apache.fineract.infrastructure.core.domain.AbstractAuditableWithUTCDateTimeCustom;
 import org.apache.fineract.portfolio.common.domain.PeriodFrequencyType;
 import org.apache.fineract.portfolio.loanaccount.domain.LoanTransaction;
@@ -56,10 +58,19 @@ public class LoanReAgeParameter extends AbstractAuditableWithUTCDateTimeCustom<L
     @Column(name = "number_of_installments", nullable = false)
     private Integer numberOfInstallments;
 
+    @Enumerated(EnumType.STRING)
+    @Column(name = "interest_handling_type")
+    private LoanReAgeInterestHandlingType interestHandlingType;
+
+    @ManyToOne
+    @JoinColumn(name = "reage_reason_code_value_id", nullable = true)
+    private CodeValue reageReason;
+
     // for JPA, don't use
     protected LoanReAgeParameter() {}
 
     public LoanReAgeParameter getCopy(LoanTransaction loanTransaction) {
-        return new LoanReAgeParameter(loanTransaction, frequencyType, frequencyNumber, startDate, numberOfInstallments);
+        return new LoanReAgeParameter(loanTransaction, frequencyType, frequencyNumber, startDate, numberOfInstallments,
+                interestHandlingType, reageReason);
     }
 }

fineract-loan/src/main/java/org/apache/fineract/portfolio/loanaccount/mapper/LoanTransactionMapper.java

@@ -33,6 +33,9 @@ public interface LoanTransactionMapper {
     @Mapping(target = "loanRepaymentScheduleInstallments", ignore = true)
     @Mapping(target = "writeOffReasonOptions", ignore = true)
     @Mapping(target = "chargeOffReasonOptions", ignore = true)
+    @Mapping(target = "reAgeReasonOptions", ignore = true)
+    @Mapping(target = "periodFrequencyOptions", ignore = true)
+    @Mapping(target = "reAgeInterestHandlingOptions", ignore = true)
     @Mapping(target = "classificationOptions", ignore = true)
     @Mapping(target = "paymentTypeOptions", ignore = true)
     @Mapping(target = "overpaymentPortion", ignore = true)

fineract-loan/src/main/java/org/apache/fineract/portfolio/loanaccount/service/LoanReadPlatformService.java

@@ -165,4 +165,5 @@ org.springframework.data.domain.Page<LoanTransactionData> retrieveLoanTransactio
 
     Long getResolvedLoanTransactionId(Long transactionId, ExternalId externalTransactionId);
 
+    LoanTransactionData retrieveLoanReAgeTemplate(Long loanId);
 }