FINERACT-2232: Generalization of StringEnumOptionData enums

fineract-core/src/main/java/org/apache/fineract/infrastructure/core/api/ApiFacingEnum.java

@@ -0,0 +1,43 @@
+/**
+ * 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.infrastructure.core.api;
+
+import java.util.Arrays;
+import java.util.List;
+import org.apache.fineract.infrastructure.core.data.StringEnumOptionData;
+
+public interface ApiFacingEnum<T extends Enum<T> & ApiFacingEnum<T>> {
+
+    static <T extends Enum<T> & ApiFacingEnum<T>> List<StringEnumOptionData> getValuesAsStringEnumOptionDataList(Class<T> clazz) {
+        return Arrays.stream(clazz.getEnumConstants()).map(v -> new StringEnumOptionData(v.name(), v.getCode(), v.getHumanReadableName()))
+                .toList();
+    }
+
+    static <T extends Enum<T> & ApiFacingEnum<T>> StringEnumOptionData getStringEnumOptionData(Class<T> clazz, String name) {
+        return name == null || name.trim().isEmpty() ? null : Enum.valueOf(clazz, name).getValueAsStringEnumOptionData();
+    }
+
+    default StringEnumOptionData getValueAsStringEnumOptionData() {
+        return new StringEnumOptionData(((Enum<T>) this).name(), getCode(), getHumanReadableName());
+    }
+
+    String getCode();
+
+    String getHumanReadableName();
+}

fineract-core/src/main/java/org/apache/fineract/portfolio/common/domain/DaysInYearCustomStrategyType.java

@@ -18,11 +18,9 @@
  */
 package org.apache.fineract.portfolio.common.domain;
 
-import java.util.Arrays;
-import java.util.List;
 import lombok.Getter;
 import lombok.RequiredArgsConstructor;
-import org.apache.fineract.infrastructure.core.data.StringEnumOptionData;
+import org.apache.fineract.infrastructure.core.api.ApiFacingEnum;
 
 /**
  * Defines the method of leap year calculation for determining the number of days in a year.
@@ -53,7 +51,7 @@ import org.apache.fineract.infrastructure.core.data.StringEnumOptionData;
  */
 @Getter
 @RequiredArgsConstructor
-public enum DaysInYearCustomStrategyType {
+public enum DaysInYearCustomStrategyType implements ApiFacingEnum<DaysInYearCustomStrategyType> {
 
     /** Always considers 366 days in a leap year. */
     FULL_LEAP_YEAR("DaysInYearCustomStrategyType.fullLeapYear", "Full Leap Year"),
@@ -64,15 +62,4 @@ public enum DaysInYearCustomStrategyType {
     private final String code;
     private final String humanReadableName;
 
-    public static List<StringEnumOptionData> getValuesAsStringEnumOptionDataList() {
-        return Arrays.stream(values()).map(v -> new StringEnumOptionData(v.name(), v.getCode(), v.getHumanReadableName())).toList();
-    }
-
-    public StringEnumOptionData getValueAsStringEnumOptionData() {
-        return new StringEnumOptionData(name(), getCode(), getHumanReadableName());
-    }
-
-    public static StringEnumOptionData getStringEnumOptionData(String name) {
-        return name == null || name.trim().isEmpty() ? null : DaysInYearCustomStrategyType.valueOf(name).getValueAsStringEnumOptionData();
-    }
 }

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

@@ -18,31 +18,17 @@
  */
 package org.apache.fineract.portfolio.loanaccount.domain;
 
-import java.util.Arrays;
-import java.util.List;
 import lombok.Getter;
 import lombok.RequiredArgsConstructor;
-import org.apache.fineract.infrastructure.core.data.StringEnumOptionData;
+import org.apache.fineract.infrastructure.core.api.ApiFacingEnum;
 
 @Getter
 @RequiredArgsConstructor
-public enum LoanCapitalizedIncomeCalculationType {
+public enum LoanCapitalizedIncomeCalculationType implements ApiFacingEnum<LoanCapitalizedIncomeCalculationType> {
 
     FLAT("loanCapitalizedIncomeCalculationType.flat", "Flat");
 
     private final String code;
     private final String humanReadableName;
 
-    public static List<StringEnumOptionData> getValuesAsStringEnumOptionDataList() {
-        return Arrays.stream(values()).map(v -> new StringEnumOptionData(v.name(), v.getCode(), v.getHumanReadableName())).toList();
-    }
-
-    public StringEnumOptionData getValueAsStringEnumOptionData() {
-        return new StringEnumOptionData(name(), getCode(), getHumanReadableName());
-    }
-
-    public static StringEnumOptionData getStringEnumOptionData(String name) {
-        return name == null || name.trim().isEmpty() ? null
-                : LoanCapitalizedIncomeCalculationType.valueOf(name).getValueAsStringEnumOptionData();
-    }
 }

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

@@ -18,30 +18,17 @@
  */
 package org.apache.fineract.portfolio.loanaccount.domain;
 
-import java.util.Arrays;
-import java.util.List;
 import lombok.Getter;
 import lombok.RequiredArgsConstructor;
-import org.apache.fineract.infrastructure.core.data.StringEnumOptionData;
+import org.apache.fineract.infrastructure.core.api.ApiFacingEnum;
 
 @Getter
 @RequiredArgsConstructor
-public enum LoanCapitalizedIncomeStrategy {
+public enum LoanCapitalizedIncomeStrategy implements ApiFacingEnum<LoanCapitalizedIncomeStrategy> {
 
     EQUAL_AMORTIZATION("capitalizedIncome.strategy.equalAmortization", "Equal amortization");
 
     private final String code;
     private final String humanReadableName;
 
-    public static List<StringEnumOptionData> getValuesAsStringEnumOptionDataList() {
-        return Arrays.stream(values()).map(v -> new StringEnumOptionData(v.name(), v.getCode(), v.getHumanReadableName())).toList();
-    }
-
-    public StringEnumOptionData getValueAsStringEnumOptionData() {
-        return new StringEnumOptionData(name(), getCode(), getHumanReadableName());
-    }
-
-    public static StringEnumOptionData getStringEnumOptionData(String name) {
-        return name == null || name.trim().isEmpty() ? null : LoanCapitalizedIncomeStrategy.valueOf(name).getValueAsStringEnumOptionData();
-    }
 }

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

@@ -18,15 +18,13 @@
  */
 package org.apache.fineract.portfolio.loanaccount.domain;
 
-import java.util.Arrays;
-import java.util.List;
 import lombok.Getter;
 import lombok.RequiredArgsConstructor;
-import org.apache.fineract.infrastructure.core.data.StringEnumOptionData;
+import org.apache.fineract.infrastructure.core.api.ApiFacingEnum;
 
 @Getter
 @RequiredArgsConstructor
-public enum LoanChargeOffBehaviour {
+public enum LoanChargeOffBehaviour implements ApiFacingEnum<LoanChargeOffBehaviour> {
 
     REGULAR("chargeOffBehaviour.regular", "Regular"), //
     ZERO_INTEREST("chargeOffBehaviour.zeroInterest", "Zero interest after charge-off"), //
@@ -36,11 +34,4 @@ public enum LoanChargeOffBehaviour {
     private final String code;
     private final String humanReadableName;
 
-    public static List<StringEnumOptionData> getValuesAsStringEnumOptionDataList() {
-        return Arrays.stream(values()).map(v -> new StringEnumOptionData(v.name(), v.getCode(), v.getHumanReadableName())).toList();
-    }
-
-    public StringEnumOptionData getValueAsStringEnumOptionData() {
-        return new StringEnumOptionData(name(), getCode(), getHumanReadableName());
-    }
 }

fineract-loan/src/main/java/org/apache/fineract/portfolio/loanproduct/data/LoanProductData.java

@@ -34,6 +34,7 @@ import org.apache.fineract.accounting.producttoaccountmapping.data.ChargeOffReas
 import org.apache.fineract.accounting.producttoaccountmapping.data.ChargeToGLAccountMapper;
 import org.apache.fineract.accounting.producttoaccountmapping.data.PaymentTypeToGLAccountMapper;
 import org.apache.fineract.infrastructure.codes.data.CodeValueData;
+import org.apache.fineract.infrastructure.core.api.ApiFacingEnum;
 import org.apache.fineract.infrastructure.core.data.EnumOptionData;
 import org.apache.fineract.infrastructure.core.data.StringEnumOptionData;
 import org.apache.fineract.organisation.monetary.data.CurrencyData;
@@ -976,9 +977,10 @@ public class LoanProductData implements Serializable {
         this.chargeOffBehaviourOptions = null;
         this.chargeOffReasonOptions = null;
         this.interestRecognitionOnDisbursementDate = interestRecognitionOnDisbursementDate;
-        this.daysInYearCustomStrategyOptions = DaysInYearCustomStrategyType.getValuesAsStringEnumOptionDataList();
+        this.daysInYearCustomStrategyOptions = ApiFacingEnum.getValuesAsStringEnumOptionDataList(DaysInYearCustomStrategyType.class);
-        this.capitalizedIncomeCalculationTypeOptions = LoanCapitalizedIncomeCalculationType.getValuesAsStringEnumOptionDataList();
+        this.capitalizedIncomeCalculationTypeOptions = ApiFacingEnum
-        this.capitalizedIncomeStrategyOptions = LoanCapitalizedIncomeStrategy.getValuesAsStringEnumOptionDataList();
+                .getValuesAsStringEnumOptionDataList(LoanCapitalizedIncomeCalculationType.class);
+        this.capitalizedIncomeStrategyOptions = ApiFacingEnum.getValuesAsStringEnumOptionDataList(LoanCapitalizedIncomeStrategy.class);
     }
 
     public LoanProductData(final LoanProductData productData, final Collection<ChargeData> chargeOptions,

fineract-loan/src/main/java/org/apache/fineract/portfolio/loanproduct/domain/LoanSupportedInterestRefundTypes.java

@@ -18,16 +18,14 @@
  */
 package org.apache.fineract.portfolio.loanproduct.domain;
 
-import java.util.Arrays;
-import java.util.List;
 import lombok.Getter;
 import lombok.RequiredArgsConstructor;
-import org.apache.fineract.infrastructure.core.data.StringEnumOptionData;
+import org.apache.fineract.infrastructure.core.api.ApiFacingEnum;
 import org.apache.fineract.portfolio.loanaccount.domain.LoanTransactionType;
 
 @Getter
 @RequiredArgsConstructor
-public enum LoanSupportedInterestRefundTypes {
+public enum LoanSupportedInterestRefundTypes implements ApiFacingEnum<LoanSupportedInterestRefundTypes> {
 
     MERCHANT_ISSUED_REFUND(LoanTransactionType.MERCHANT_ISSUED_REFUND, "loanRefundType.merchant_issued_refund", "Merchant issued refund"), //
     PAYOUT_REFUND(LoanTransactionType.PAYOUT_REFUND, "loanRefundType.payout_refund", "Payout refund"), //
@@ -37,11 +35,4 @@ public enum LoanSupportedInterestRefundTypes {
     private final String code;
     private final String humanReadableName;
 
-    public static List<StringEnumOptionData> getValuesAsStringEnumOptionDataList() {
-        return Arrays.stream(values()).map(v -> new StringEnumOptionData(v.name(), v.getCode(), v.getHumanReadableName())).toList();
-    }
-
-    public StringEnumOptionData getValueAsStringEnumOptionData() {
-        return new StringEnumOptionData(name(), getCode(), getHumanReadableName());
-    }
 }

fineract-provider/src/main/java/org/apache/fineract/portfolio/loanaccount/api/LoansApiResource.java

@@ -67,6 +67,7 @@ import org.apache.fineract.infrastructure.bulkimport.service.BulkImportWorkbookS
 import org.apache.fineract.infrastructure.codes.data.CodeValueData;
 import org.apache.fineract.infrastructure.codes.service.CodeValueReadPlatformService;
 import org.apache.fineract.infrastructure.configuration.domain.ConfigurationDomainService;
+import org.apache.fineract.infrastructure.core.api.ApiFacingEnum;
 import org.apache.fineract.infrastructure.core.api.ApiParameterHelper;
 import org.apache.fineract.infrastructure.core.api.ApiRequestParameterHelper;
 import org.apache.fineract.infrastructure.core.api.JsonQuery;
@@ -1137,9 +1138,9 @@ public class LoansApiResource {
                 loanCollateralOptions, calendarOptions, notes, accountLinkingOptions, linkedAccount, disbursementData, emiAmountVariations,
                 overdueCharges, paidInAdvanceTemplate, interestRatesPeriods, clientActiveLoanOptions, rates, isRatesEnabled, collectionData,
                 LoanScheduleType.getValuesAsEnumOptionDataList(), LoanScheduleProcessingType.getValuesAsEnumOptionDataList(),
-                loanTermVariations, DaysInYearCustomStrategyType.getValuesAsStringEnumOptionDataList(),
+                loanTermVariations, ApiFacingEnum.getValuesAsStringEnumOptionDataList(DaysInYearCustomStrategyType.class),
-                LoanCapitalizedIncomeCalculationType.getValuesAsStringEnumOptionDataList(),
+                ApiFacingEnum.getValuesAsStringEnumOptionDataList(LoanCapitalizedIncomeCalculationType.class),
-                LoanCapitalizedIncomeStrategy.getValuesAsStringEnumOptionDataList());
+                ApiFacingEnum.getValuesAsStringEnumOptionDataList(LoanCapitalizedIncomeStrategy.class));
 
         final ApiRequestJsonSerializationSettings settings = this.apiRequestParameterHelper.process(uriInfo.getQueryParameters(),
                 mandatoryResponseParameters);

fineract-provider/src/main/java/org/apache/fineract/portfolio/loanaccount/service/LoanReadPlatformServiceImpl.java

@@ -43,6 +43,7 @@ import org.apache.commons.lang3.StringUtils;
 import org.apache.fineract.infrastructure.codes.data.CodeValueData;
 import org.apache.fineract.infrastructure.codes.service.CodeValueReadPlatformService;
 import org.apache.fineract.infrastructure.configuration.domain.ConfigurationDomainService;
+import org.apache.fineract.infrastructure.core.api.ApiFacingEnum;
 import org.apache.fineract.infrastructure.core.data.EnumOptionData;
 import org.apache.fineract.infrastructure.core.data.StringEnumOptionData;
 import org.apache.fineract.infrastructure.core.domain.ExternalId;
@@ -1101,13 +1102,13 @@ public class LoanReadPlatformServiceImpl implements LoanReadPlatformService, Loa
             final Integer fixedLength = JdbcSupport.getInteger(rs, "fixedLength");
             final LoanChargeOffBehaviour chargeOffBehaviour = LoanChargeOffBehaviour.valueOf(rs.getString("chargeOffBehaviour"));
             final boolean interestRecognitionOnDisbursementDate = rs.getBoolean("interestRecognitionOnDisbursementDate");
-            final StringEnumOptionData daysInYearCustomStrategy = DaysInYearCustomStrategyType
+            final StringEnumOptionData daysInYearCustomStrategy = ApiFacingEnum.getStringEnumOptionData(DaysInYearCustomStrategyType.class,
-                    .getStringEnumOptionData(rs.getString("daysInYearCustomStrategy"));
+                    rs.getString("daysInYearCustomStrategy"));
             final boolean enableIncomeCapitalization = rs.getBoolean("enableIncomeCapitalization");
-            final StringEnumOptionData capitalizedIncomeCalculationType = LoanCapitalizedIncomeCalculationType
+            final StringEnumOptionData capitalizedIncomeCalculationType = ApiFacingEnum
-                    .getStringEnumOptionData(rs.getString("capitalizedIncomeCalculationType"));
+                    .getStringEnumOptionData(LoanCapitalizedIncomeCalculationType.class, rs.getString("capitalizedIncomeCalculationType"));
-            final StringEnumOptionData capitalizedIncomeStrategy = LoanCapitalizedIncomeStrategy
+            final StringEnumOptionData capitalizedIncomeStrategy = ApiFacingEnum
-                    .getStringEnumOptionData(rs.getString("capitalizedIncomeStrategy"));
+                    .getStringEnumOptionData(LoanCapitalizedIncomeStrategy.class, rs.getString("capitalizedIncomeStrategy"));
 
             return LoanAccountData.basicLoanDetails(id, accountNo, status, externalId, clientId, clientAccountNo, clientName,
                     clientOfficeId, clientExternalId, groupData, loanType, loanProductId, loanProductName, loanProductDescription,

fineract-provider/src/main/java/org/apache/fineract/portfolio/loanproduct/api/LoanProductsApiResource.java

@@ -58,6 +58,7 @@ import org.apache.fineract.commands.service.PortfolioCommandSourceWritePlatformS
 import org.apache.fineract.infrastructure.codes.data.CodeValueData;
 import org.apache.fineract.infrastructure.codes.service.CodeValueReadPlatformService;
 import org.apache.fineract.infrastructure.configuration.domain.ConfigurationDomainService;
+import org.apache.fineract.infrastructure.core.api.ApiFacingEnum;
 import org.apache.fineract.infrastructure.core.api.ApiParameterHelper;
 import org.apache.fineract.infrastructure.core.api.ApiRequestParameterHelper;
 import org.apache.fineract.infrastructure.core.data.CommandProcessingResult;
@@ -437,17 +438,18 @@ public class LoanProductsApiResource {
         final List<EnumOptionData> advancedPaymentAllocationTypes = PaymentAllocationType.getValuesAsEnumOptionDataList();
         final List<EnumOptionData> creditAllocationTransactionTypes = CreditAllocationTransactionType.getValuesAsEnumOptionDataList();
         final List<EnumOptionData> creditAllocationAllocationTypes = AllocationType.getValuesAsEnumOptionDataList();
-        final List<StringEnumOptionData> supportedInterestRefundTypesOptions = LoanSupportedInterestRefundTypes
+        final List<StringEnumOptionData> supportedInterestRefundTypesOptions = ApiFacingEnum
-                .getValuesAsStringEnumOptionDataList();
+                .getValuesAsStringEnumOptionDataList(LoanSupportedInterestRefundTypes.class);
-        final List<StringEnumOptionData> chargeOffBehaviourOptions = LoanChargeOffBehaviour.getValuesAsStringEnumOptionDataList();
+        final List<StringEnumOptionData> chargeOffBehaviourOptions = ApiFacingEnum
+                .getValuesAsStringEnumOptionDataList(LoanChargeOffBehaviour.class);
         final List<CodeValueData> chargeOffReasonOptions = codeValueReadPlatformService
                 .retrieveCodeValuesByCode(LoanApiConstants.CHARGE_OFF_REASONS);
-        final List<StringEnumOptionData> daysInYearCustomStrategyOptions = DaysInYearCustomStrategyType
+        final List<StringEnumOptionData> daysInYearCustomStrategyOptions = ApiFacingEnum
-                .getValuesAsStringEnumOptionDataList();
+                .getValuesAsStringEnumOptionDataList(DaysInYearCustomStrategyType.class);
-        final List<StringEnumOptionData> capitalizedIncomeCalculationTypeOptions = LoanCapitalizedIncomeCalculationType
+        final List<StringEnumOptionData> capitalizedIncomeCalculationTypeOptions = ApiFacingEnum
-                .getValuesAsStringEnumOptionDataList();
+                .getValuesAsStringEnumOptionDataList(LoanCapitalizedIncomeCalculationType.class);
-        final List<StringEnumOptionData> capitalizedIncomeStrategyOptions = LoanCapitalizedIncomeStrategy
+        final List<StringEnumOptionData> capitalizedIncomeStrategyOptions = ApiFacingEnum
-                .getValuesAsStringEnumOptionDataList();
+                .getValuesAsStringEnumOptionDataList(LoanCapitalizedIncomeStrategy.class);
 
         return new LoanProductData(productData, chargeOptions, penaltyOptions, paymentTypeOptions, currencyOptions, amortizationTypeOptions,
                 interestTypeOptions, interestCalculationPeriodTypeOptions, repaymentFrequencyTypeOptions, interestRateFrequencyTypeOptions,

fineract-provider/src/main/java/org/apache/fineract/portfolio/loanproduct/service/LoanProductReadPlatformServiceImpl.java

@@ -29,6 +29,7 @@ import java.util.List;
 import java.util.concurrent.atomic.AtomicInteger;
 import lombok.RequiredArgsConstructor;
 import org.apache.fineract.accounting.common.AccountingEnumerations;
+import org.apache.fineract.infrastructure.core.api.ApiFacingEnum;
 import org.apache.fineract.infrastructure.core.data.EnumOptionData;
 import org.apache.fineract.infrastructure.core.data.StringEnumOptionData;
 import org.apache.fineract.infrastructure.core.domain.ExternalId;
@@ -435,8 +436,8 @@ public class LoanProductReadPlatformServiceImpl implements LoanProductReadPlatfo
             final int daysInMonth = JdbcSupport.getInteger(rs, "daysInMonth");
             final EnumOptionData daysInMonthType = CommonEnumerations.daysInMonthType(daysInMonth);
             final int daysInYear = JdbcSupport.getInteger(rs, "daysInYear");
-            final StringEnumOptionData daysInYearCustomStrategy = DaysInYearCustomStrategyType
+            final StringEnumOptionData daysInYearCustomStrategy = ApiFacingEnum.getStringEnumOptionData(DaysInYearCustomStrategyType.class,
-                    .getStringEnumOptionData(rs.getString("daysInYearCustomStrategy"));
+                    rs.getString("daysInYearCustomStrategy"));
             final EnumOptionData daysInYearType = CommonEnumerations.daysInYearType(daysInYear);
             final Integer installmentAmountInMultiplesOf = JdbcSupport.getInteger(rs, "installmentAmountInMultiplesOf");
             final boolean canDefineInstallmentAmount = rs.getBoolean("canDefineInstallmentAmount");
@@ -558,10 +559,10 @@ public class LoanProductReadPlatformServiceImpl implements LoanProductReadPlatfo
             final LoanChargeOffBehaviour loanChargeOffBehaviour = LoanChargeOffBehaviour.valueOf(chargeOffBehaviourStr);
             final boolean interestRecognitionOnDisbursementDate = rs.getBoolean("interestRecognitionOnDisbursementDate");
             final boolean enableIncomeCapitalization = rs.getBoolean("enableIncomeCapitalization");
-            final StringEnumOptionData capitalizedIncomeCalculationType = LoanCapitalizedIncomeCalculationType
+            final StringEnumOptionData capitalizedIncomeCalculationType = ApiFacingEnum
-                    .getStringEnumOptionData(rs.getString("capitalizedIncomeCalculationType"));
+                    .getStringEnumOptionData(LoanCapitalizedIncomeCalculationType.class, rs.getString("capitalizedIncomeCalculationType"));
-            final StringEnumOptionData capitalizedIncomeStrategy = LoanCapitalizedIncomeStrategy
+            final StringEnumOptionData capitalizedIncomeStrategy = ApiFacingEnum
-                    .getStringEnumOptionData(rs.getString("capitalizedIncomeStrategy"));
+                    .getStringEnumOptionData(LoanCapitalizedIncomeStrategy.class, rs.getString("capitalizedIncomeStrategy"));
 
             return new LoanProductData(id, name, shortName, description, currency, principal, minPrincipal, maxPrincipal, tolerance,
                     numberOfRepayments, minNumberOfRepayments, maxNumberOfRepayments, repaymentEvery, interestRatePerPeriod,