FINERACT-1981: Provide more general EMI calculator interface

ruchiD · Jul 12, 2024 · a4f077d · a4f077d
1 parent c9d1b81
commit a4f077d
Show file tree

Hide file tree

Showing 5 changed files with 89 additions and 156 deletions.
diff --git a/...t/portfolio/loanaccount/loanschedule/domain/AbstractProgressiveLoanScheduleGenerator.java b/...t/portfolio/loanaccount/loanschedule/domain/AbstractProgressiveLoanScheduleGenerator.java
@@ -119,13 +119,16 @@ public LoanScheduleModel generate(final MathContext mc, final LoanApplicationTer
                         : scheduleParams.getPeriodStartDate();
                 List<PreGeneratedLoanSchedulePeriod> expectedRepaymentPeriods = getScheduledDateGenerator()
                         .generateRepaymentPeriods(startDate, loanApplicationTerms, holidayDetailDTO);
-                emiCalculationResult = getEMICalculator().calculateEMIValueAndRateFactors(loanApplicationTerms, scheduleParams,
-                        expectedRepaymentPeriods, mc);
+                emiCalculationResult = getEMICalculator().calculateEMIValueAndRateFactors(scheduleParams.getOutstandingBalanceAsPerRest(),
+                        loanApplicationTerms.toLoanProductRelatedDetail(), expectedRepaymentPeriods, scheduleParams.getPeriodNumber(),
+                        loanApplicationTerms.getNumberOfRepayments(), mc);
             }
 
             // 5 determine principal,interest of repayment period
-            PrincipalInterest principalInterestForThisPeriod = calculatePrincipalInterestComponentsForPeriod(loanApplicationTerms,
-                    scheduleParams, emiCalculationResult, mc);
+            PrincipalInterest principalInterestForThisPeriod = getEMICalculator().calculatePrincipalInterestComponentsForPeriod(
+                    emiCalculationResult, scheduleParams.getOutstandingBalanceAsPerRest(),
+                    loanApplicationTerms.getInstallmentAmountInMultiplesOf(), scheduleParams.getPeriodNumber(),
+                    loanApplicationTerms.getActualNoOfRepaymnets(), mc);
 
             // update cumulative fields for principal
             currentPeriodParams.setPrincipalForThisPeriod(principalInterestForThisPeriod.principal());
@@ -237,9 +240,6 @@ public LoanRepaymentScheduleInstallment calculatePrepaymentAmount(MonetaryCurren
 
     public abstract PaymentPeriodsInOneYearCalculator getPaymentPeriodsInOneYearCalculator();
 
-    public abstract PrincipalInterest calculatePrincipalInterestComponentsForPeriod(LoanApplicationTerms loanApplicationTerms,
-            LoanScheduleParams loanScheduleParams, EMICalculationResult emiCalculationResult, MathContext mc);
-
     protected abstract EMICalculator getEMICalculator();
 
     // Private, internal methods

diff --git a/.../fineract/portfolio/loanaccount/loanschedule/domain/ProgressiveLoanScheduleGenerator.java b/.../fineract/portfolio/loanaccount/loanschedule/domain/ProgressiveLoanScheduleGenerator.java
@@ -18,12 +18,7 @@
  */
 package org.apache.fineract.portfolio.loanaccount.loanschedule.domain;
 
-import java.math.BigDecimal;
-import java.math.MathContext;
 import lombok.RequiredArgsConstructor;
-import org.apache.fineract.organisation.monetary.domain.Money;
-import org.apache.fineract.portfolio.loanaccount.loanschedule.data.LoanScheduleParams;
-import org.apache.fineract.portfolio.loanproduct.calc.EMICalculationResult;
 import org.apache.fineract.portfolio.loanproduct.calc.EMICalculator;
 import org.springframework.stereotype.Component;
 
@@ -49,31 +44,4 @@ public PaymentPeriodsInOneYearCalculator getPaymentPeriodsInOneYearCalculator()
     protected EMICalculator getEMICalculator() {
         return emiCalculator;
     }
-
-    @Override
-    public PrincipalInterest calculatePrincipalInterestComponentsForPeriod(final LoanApplicationTerms loanApplicationTerms,
-            final LoanScheduleParams loanScheduleParams, final EMICalculationResult emiCalculationResult, final MathContext mc) {
-
-        final Money equalMonthlyInstallmentValue = loanApplicationTerms.getInstallmentAmountInMultiplesOf() != null
-                ? Money.roundToMultiplesOf(emiCalculationResult.getEqualMonthlyInstallmentValue(),
-                        loanApplicationTerms.getInstallmentAmountInMultiplesOf())
-                : emiCalculationResult.getEqualMonthlyInstallmentValue();
-        final BigDecimal rateFactorMinus1 = emiCalculationResult.getNextRepaymentPeriodRateFactorMinus1();
-        final Money calculatedInterest = loanScheduleParams.getOutstandingBalanceAsPerRest().multipliedBy(rateFactorMinus1);
-        final Money calculatedPrincipal = equalMonthlyInstallmentValue.minus(calculatedInterest);
-
-        return new PrincipalInterest(
-                adjustCalculatedPrincipalWithRemainingBalanceInLastPeriod(calculatedPrincipal, loanApplicationTerms, loanScheduleParams),
-                calculatedInterest, Money.zero(loanApplicationTerms.getCurrency()));
-    }
-
-    private Money adjustCalculatedPrincipalWithRemainingBalanceInLastPeriod(final Money calculatedPrincipal,
-            final LoanApplicationTerms loanApplicationTerms, final LoanScheduleParams loanScheduleParams) {
-        final boolean isLastRepaymentPeriod = loanScheduleParams.getPeriodNumber() == loanApplicationTerms.getActualNoOfRepaymnets();
-        if (isLastRepaymentPeriod) {
-            final Money remainingAmount = loanScheduleParams.getOutstandingBalanceAsPerRest().minus(calculatedPrincipal);
-            return calculatedPrincipal.plus(remainingAmount);
-        }
-        return calculatedPrincipal;
-    }
 }
diff --git a/...sive-loan/src/main/java/org/apache/fineract/portfolio/loanproduct/calc/EMICalculator.java b/...sive-loan/src/main/java/org/apache/fineract/portfolio/loanproduct/calc/EMICalculator.java
@@ -20,12 +20,18 @@
 
 import java.math.MathContext;
 import java.util.List;
-import org.apache.fineract.portfolio.loanaccount.loanschedule.data.LoanScheduleParams;
-import org.apache.fineract.portfolio.loanaccount.loanschedule.domain.LoanApplicationTerms;
+import org.apache.fineract.organisation.monetary.domain.Money;
 import org.apache.fineract.portfolio.loanaccount.loanschedule.domain.LoanScheduleModelPeriod;
+import org.apache.fineract.portfolio.loanaccount.loanschedule.domain.PrincipalInterest;
+import org.apache.fineract.portfolio.loanproduct.domain.LoanProductRelatedDetail;
 
 public interface EMICalculator {
 
-    EMICalculationResult calculateEMIValueAndRateFactors(LoanApplicationTerms loanApplicationTerms, LoanScheduleParams scheduleParams,
-            List<? extends LoanScheduleModelPeriod> expectedRepaymentPeriods, MathContext mc);
+    EMICalculationResult calculateEMIValueAndRateFactors(Money outstandingBalanceAsPerRest,
+            LoanProductRelatedDetail loanProductRelatedDetail, List<? extends LoanScheduleModelPeriod> expectedRepaymentPeriods,
+            Integer actualPeriodNumber, Integer numberOfRepayments, MathContext mc);
+
+    PrincipalInterest calculatePrincipalInterestComponentsForPeriod(EMICalculationResult emiCalculationResult,
+            Money outstandingBalanceAsPerRest, Integer installmentAmountInMultiplesOf, Integer actualPeriodNumber,
+            Integer actualNoOfRepayments, MathContext mc);
 }