FINERACT-1926 AssetOwnerTransferDetails added

2023-06-06 17:50:49 +02:00
parent ebd1ea2696
commit 6172b62456
14 changed files with 301 additions and 27 deletions
@@ -21,6 +21,7 @@ package org.apache.fineract.investor.cob.loan;
 import java.math.BigDecimal;
 import java.time.LocalDate;
 import java.util.List;
+import java.util.Objects;
 import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
 import org.apache.fineract.cob.loan.LoanCOBBusinessStep;
@@ -28,6 +29,7 @@ import org.apache.fineract.infrastructure.core.service.DateUtils;
 import org.apache.fineract.investor.data.ExternalTransferStatus;
 import org.apache.fineract.investor.data.ExternalTransferSubStatus;
 import org.apache.fineract.investor.domain.ExternalAssetOwnerTransfer;
+import org.apache.fineract.investor.domain.ExternalAssetOwnerTransferDetails;
 import org.apache.fineract.investor.domain.ExternalAssetOwnerTransferLoanMapping;
 import org.apache.fineract.investor.domain.ExternalAssetOwnerTransferLoanMappingRepository;
 import org.apache.fineract.investor.domain.ExternalAssetOwnerTransferRepository;
@@ -89,7 +91,7 @@ public class LoanAccountOwnerTransferBusinessStep implements LoanCOBBusinessStep
            final ExternalAssetOwnerTransfer buybackExternalAssetOwnerTransfer) {
        ExternalAssetOwnerTransfer activeExternalAssetOwnerTransfer = externalAssetOwnerTransferRepository
                .findOne((root, query, criteriaBuilder) -> criteriaBuilder.and(criteriaBuilder.equal(root.get("loanId"), loan.getId()),
-                        criteriaBuilder.equal(root.get("ownerId"), buybackExternalAssetOwnerTransfer.getOwnerId()),
+                        criteriaBuilder.equal(root.get("owner"), buybackExternalAssetOwnerTransfer.getOwner()),
                        criteriaBuilder.equal(root.get("status"), ExternalTransferStatus.ACTIVE),
                        criteriaBuilder.equal(root.get("effectiveDateTo"), FUTURE_DATE_9999_12_31)))
                .orElseThrow();
@@ -102,11 +104,12 @@ public class LoanAccountOwnerTransferBusinessStep implements LoanCOBBusinessStep
            ExternalAssetOwnerTransfer buybackExternalAssetOwnerTransfer, ExternalAssetOwnerTransfer activeExternalAssetOwnerTransfer) {
        activeExternalAssetOwnerTransfer.setEffectiveDateTo(settlementDate);
        buybackExternalAssetOwnerTransfer.setEffectiveDateTo(buybackExternalAssetOwnerTransfer.getEffectiveDateFrom());
+        buybackExternalAssetOwnerTransfer
+                .setExternalAssetOwnerTransferDetails(createAssetOwnerTransferDetails(loan, buybackExternalAssetOwnerTransfer));
        externalAssetOwnerTransferRepository.save(activeExternalAssetOwnerTransfer);
        buybackExternalAssetOwnerTransfer = externalAssetOwnerTransferRepository.save(buybackExternalAssetOwnerTransfer);
        externalAssetOwnerTransferLoanMappingRepository.deleteByLoanIdAndOwnerTransfer(loan.getId(), activeExternalAssetOwnerTransfer);
        // TODO: create asset ownership accounting entries
-        // TODO: create asset ownership transaction entries
        return buybackExternalAssetOwnerTransfer;
    }

@@ -116,8 +119,9 @@ public class LoanAccountOwnerTransferBusinessStep implements LoanCOBBusinessStep
        if (isTransferable(loan)) {
            newExternalAssetOwnerTransfer = createActiveEntry(settlementDate, externalAssetOwnerTransfer);
            createActiveMapping(loan.getId(), newExternalAssetOwnerTransfer);
+            newExternalAssetOwnerTransfer
+                    .setExternalAssetOwnerTransferDetails(createAssetOwnerTransferDetails(loan, newExternalAssetOwnerTransfer));
            // TODO: create asset ownership accounting entries
-            // TODO: create asset ownership transaction entries
        } else {
            ExternalTransferSubStatus subStatus = ExternalTransferSubStatus.BALANCE_ZERO;
            if (loan.getTotalOverpaid().compareTo(BigDecimal.ZERO) > 0) {
@@ -129,6 +133,23 @@ public class LoanAccountOwnerTransferBusinessStep implements LoanCOBBusinessStep
        return newExternalAssetOwnerTransfer;
    }

+    private ExternalAssetOwnerTransferDetails createAssetOwnerTransferDetails(Loan loan,
+            ExternalAssetOwnerTransfer externalAssetOwnerTransfer) {
+        ExternalAssetOwnerTransferDetails details = new ExternalAssetOwnerTransferDetails();
+        details.setExternalAssetOwnerTransfer(externalAssetOwnerTransfer);
+        details.setTotalOutstanding(Objects.requireNonNullElse(loan.getLoanSummary().getTotalOutstanding(), BigDecimal.ZERO));
+        details.setTotalPrincipalOutstanding(
+                Objects.requireNonNullElse(loan.getLoanSummary().getTotalPrincipalOutstanding(), BigDecimal.ZERO));
+        details.setTotalInterestOutstanding(
+                Objects.requireNonNullElse(loan.getLoanSummary().getTotalInterestOutstanding(), BigDecimal.ZERO));
+        details.setTotalFeeChargesOutstanding(
+                Objects.requireNonNullElse(loan.getLoanSummary().getTotalFeeChargesOutstanding(), BigDecimal.ZERO));
+        details.setTotalPenaltyChargesOutstanding(
+                Objects.requireNonNullElse(loan.getLoanSummary().getTotalPenaltyChargesOutstanding(), BigDecimal.ZERO));
+        details.setTotalOverpaid(Objects.requireNonNullElse(loan.getTotalOverpaid(), BigDecimal.ZERO));
+        return details;
+    }
+
    private void createActiveMapping(Long loanId, ExternalAssetOwnerTransfer externalAssetOwnerTransfer) {
        ExternalAssetOwnerTransferLoanMapping externalAssetOwnerTransferLoanMapping = new ExternalAssetOwnerTransferLoanMapping();
        externalAssetOwnerTransferLoanMapping.setLoanId(loanId);
@@ -157,7 +178,6 @@ public class LoanAccountOwnerTransferBusinessStep implements LoanCOBBusinessStep
            final ExternalTransferSubStatus subStatus, final LocalDate effectiveDateFrom, final LocalDate effectiveDateTo) {
        ExternalAssetOwnerTransfer newExternalAssetOwnerTransfer = new ExternalAssetOwnerTransfer();
        newExternalAssetOwnerTransfer.setOwner(externalAssetOwnerTransfer.getOwner());
-        newExternalAssetOwnerTransfer.setOwnerId(externalAssetOwnerTransfer.getOwnerId());
        newExternalAssetOwnerTransfer.setExternalId(externalAssetOwnerTransfer.getExternalId());
        newExternalAssetOwnerTransfer.setStatus(status);
        newExternalAssetOwnerTransfer.setSubStatus(subStatus);
@@ -27,6 +27,7 @@ public class ExternalTransferData {
    private Long transferId;
    private ExternalTransferOwnerData owner;
    private ExternalTransferLoanMappingData loan;
+    private ExternalTransferDataDetails details;
    private String transferExternalId;
    private String purchasePriceRatio;
    private LocalDate settlementDate;
@@ -0,0 +1,34 @@
+/**
+ * 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.investor.data;
+
+import java.math.BigDecimal;
+import lombok.Data;
+
+@Data
+public class ExternalTransferDataDetails {
+
+    private Long detailsId;
+    private BigDecimal totalOutstanding;
+    private BigDecimal totalPrincipalOutstanding;
+    private BigDecimal totalInterestOutstanding;
+    private BigDecimal totalFeeChargesOutstanding;
+    private BigDecimal totalPenaltyChargesOutstanding;
+    private BigDecimal totalOverpaid;
+}
@@ -18,12 +18,14 @@
 */
 package org.apache.fineract.investor.domain;

+import jakarta.persistence.CascadeType;
 import jakarta.persistence.Column;
 import jakarta.persistence.Entity;
 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.Getter;
@@ -41,13 +43,13 @@ import org.apache.fineract.investor.data.ExternalTransferSubStatus;
@Entity
 public class ExternalAssetOwnerTransfer extends AbstractAuditableWithUTCDateTimeCustom {

-    @Column(name = "owner_id", nullable = false)
-    private Long ownerId;
-
    @ManyToOne
-    @JoinColumn(name = "owner_id", insertable = false, updatable = false, nullable = false)
+    @JoinColumn(name = "owner_id", nullable = false)
    private ExternalAssetOwner owner;

+    @OneToOne(mappedBy = "externalAssetOwnerTransfer", cascade = CascadeType.ALL)
+    private ExternalAssetOwnerTransferDetails externalAssetOwnerTransferDetails;
+
    @Column(name = "external_id", length = 100, nullable = false)
    private ExternalId externalId;

@@ -0,0 +1,61 @@
+/**
+ * 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.investor.domain;
+
+import jakarta.persistence.CascadeType;
+import jakarta.persistence.Column;
+import jakarta.persistence.Entity;
+import jakarta.persistence.JoinColumn;
+import jakarta.persistence.OneToOne;
+import jakarta.persistence.Table;
+import java.math.BigDecimal;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+import lombok.Setter;
+import org.apache.fineract.infrastructure.core.domain.AbstractAuditableWithUTCDateTimeCustom;
+
+@Getter
+@Setter
+@Table(name = "m_external_asset_owner_transfer_details")
+@NoArgsConstructor
+@Entity
+public class ExternalAssetOwnerTransferDetails extends AbstractAuditableWithUTCDateTimeCustom {
+
+    @OneToOne(cascade = CascadeType.ALL)
+    @JoinColumn(name = "asset_owner_transfer_id", referencedColumnName = "id")
+    private ExternalAssetOwnerTransfer externalAssetOwnerTransfer;
+
+    @Column(name = "total_outstanding_derived", scale = 6, precision = 19, nullable = false)
+    private BigDecimal totalOutstanding;
+
+    @Column(name = "principal_outstanding_derived", scale = 6, precision = 19, nullable = false)
+    private BigDecimal totalPrincipalOutstanding;
+
+    @Column(name = "interest_outstanding_derived", scale = 6, precision = 19, nullable = false)
+    private BigDecimal totalInterestOutstanding;
+
+    @Column(name = "fee_charges_outstanding_derived", scale = 6, precision = 19, nullable = false)
+    private BigDecimal totalFeeChargesOutstanding;
+
+    @Column(name = "penalty_charges_outstanding_derived", scale = 6, precision = 19, nullable = false)
+    private BigDecimal totalPenaltyChargesOutstanding;
+
+    @Column(name = "total_overpaid_derived", scale = 6, precision = 19, nullable = false)
+    private BigDecimal totalOverpaid;
+}
@@ -20,9 +20,11 @@ package org.apache.fineract.investor.service;

 import org.apache.fineract.infrastructure.core.config.MapstructMapperConfig;
 import org.apache.fineract.investor.data.ExternalTransferData;
+import org.apache.fineract.investor.data.ExternalTransferDataDetails;
 import org.apache.fineract.investor.data.ExternalTransferOwnerData;
 import org.apache.fineract.investor.domain.ExternalAssetOwner;
 import org.apache.fineract.investor.domain.ExternalAssetOwnerTransfer;
+import org.apache.fineract.investor.domain.ExternalAssetOwnerTransferDetails;
 import org.mapstruct.Mapper;
 import org.mapstruct.Mapping;

@@ -39,8 +41,12 @@ public interface ExternalAssetOwnersTransferMapper {
    @Mapping(target = "purchasePriceRatio", source = "purchasePriceRatio")
    @Mapping(target = "settlementDate", source = "settlementDate")
    @Mapping(target = "status", source = "status")
+    @Mapping(target = "details", source = "externalAssetOwnerTransferDetails")
    ExternalTransferData mapTransfer(ExternalAssetOwnerTransfer source);

    ExternalTransferOwnerData mapOwner(ExternalAssetOwner source);

+    @Mapping(target = "detailsId", source = "id")
+    ExternalTransferDataDetails mapDetails(ExternalAssetOwnerTransferDetails details);
+
 }
@@ -144,7 +144,7 @@ public class ExternalAssetOwnersWriteServiceImpl implements ExternalAssetOwnersW

        ExternalAssetOwnerTransfer externalAssetOwnerTransfer = new ExternalAssetOwnerTransfer();
        externalAssetOwnerTransfer.setExternalId(externalId);
-        externalAssetOwnerTransfer.setOwnerId(effectiveTransfer.getOwnerId());
+        externalAssetOwnerTransfer.setOwner(effectiveTransfer.getOwner());
        externalAssetOwnerTransfer.setStatus(ExternalTransferStatus.BUYBACK);
        externalAssetOwnerTransfer.setLoanId(effectiveTransfer.getLoanId());
        externalAssetOwnerTransfer.setExternalLoanId(effectiveTransfer.getExternalLoanId());
@@ -218,7 +218,6 @@ public class ExternalAssetOwnersWriteServiceImpl implements ExternalAssetOwnersW
        final JsonElement json = fromApiJsonHelper.parse(apiRequestBodyAsJson);

        ExternalAssetOwner owner = getOwner(json);
-        externalAssetOwnerTransfer.setOwnerId(owner.getId());
        externalAssetOwnerTransfer.setOwner(owner);
        externalAssetOwnerTransfer.setExternalId(getTransferExternalIdFromJson(json));
        externalAssetOwnerTransfer.setStatus(ExternalTransferStatus.PENDING);
@@ -28,4 +28,5 @@
  <include relativeToChangelogFile="true" file="parts/0004_change_purchase_price_ratio_type.xml"/>
  <include relativeToChangelogFile="true" file="parts/0005_add_sale_and_buyback_command.xml"/>
  <include relativeToChangelogFile="true" file="parts/0006_asset_schemas.xml"/>
+  <include relativeToChangelogFile="true" file="parts/0007_add_external_asset_owner_transfer_details.xml"/>
 </databaseChangeLog>
@@ -0,0 +1,118 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+
+    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.
+
+-->
+<databaseChangeLog xmlns="http://www.liquibase.org/xml/ns/dbchangelog"
+                   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+                   xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-4.1.xsd">
+
+    <!-- Create the m_external_asset_owner_transfer_details table -->
+    <changeSet author="fineract" id="1" context="postgresql">
+        <createTable tableName="m_external_asset_owner_transfer_details">
+
+            <column autoIncrement="true" name="id" type="BIGINT" remarks="Internal ID">
+                <constraints nullable="false" primaryKey="true"/>
+            </column>
+
+            <column name="asset_owner_transfer_id" type="BIGINT" remarks="Id of asset owner transfer">
+                <constraints nullable="false" unique="true"
+                             uniqueConstraintName="UQ_external_asset_owner_transfer_id"/>
+            </column>
+
+            <column name="total_outstanding_derived" type="DECIMAL(19, 6)">
+                <constraints nullable="false"/>
+            </column>
+            <column name="principal_outstanding_derived" type="DECIMAL(19, 6)">
+                <constraints nullable="false"/>
+            </column>
+            <column name="interest_outstanding_derived" type="DECIMAL(19, 6)">
+                <constraints nullable="false"/>
+            </column>
+            <column name="fee_charges_outstanding_derived" type="DECIMAL(19, 6)">
+                <constraints nullable="false"/>
+            </column>
+            <column name="penalty_charges_outstanding_derived" type="DECIMAL(19, 6)">
+                <constraints nullable="false"/>
+            </column>
+            <column name="total_overpaid_derived" type="DECIMAL(19, 6)">
+                <constraints nullable="false"/>
+            </column>
+
+            <column name="created_by" type="BIGINT" />
+            <column name="created_on_utc" type="TIMESTAMP WITH TIME ZONE" />
+            <column name="last_modified_by" type="BIGINT" />
+            <column name="last_modified_on_utc" type="TIMESTAMP WITH TIME ZONE" />
+        </createTable>
+    </changeSet>
+
+    <changeSet author="fineract" id="1" context="mysql">
+        <createTable tableName="m_external_asset_owner_transfer_details">
+
+            <column autoIncrement="true" name="id" type="BIGINT" remarks="Internal ID">
+                <constraints nullable="false" primaryKey="true"/>
+            </column>
+
+            <column name="asset_owner_transfer_id" type="BIGINT" remarks="Id of asset owner transfer">
+                <constraints nullable="false" unique="true"
+                             uniqueConstraintName="UQ_external_asset_owner_transfer_id"/>
+            </column>
+
+            <column name="total_outstanding_derived" type="DECIMAL(19, 6)">
+                <constraints nullable="false"/>
+            </column>
+            <column name="principal_outstanding_derived" type="DECIMAL(19, 6)">
+                <constraints nullable="false"/>
+            </column>
+            <column name="interest_outstanding_derived" type="DECIMAL(19, 6)">
+                <constraints nullable="false"/>
+            </column>
+            <column name="fee_charges_outstanding_derived" type="DECIMAL(19, 6)">
+                <constraints nullable="false"/>
+            </column>
+            <column name="penalty_charges_outstanding_derived" type="DECIMAL(19, 6)">
+                <constraints nullable="false"/>
+            </column>
+            <column name="total_overpaid_derived" type="DECIMAL(19, 6)">
+                <constraints nullable="false"/>
+            </column>
+
+            <column name="created_by" type="BIGINT" />
+            <column name="created_on_utc" type="DATETIME" />
+            <column name="last_modified_by" type="BIGINT" />
+            <column name="last_modified_on_utc" type="DATETIME" />
+        </createTable>
+    </changeSet>
+
+    <changeSet author="fineract" id="2">
+        <addForeignKeyConstraint baseColumnNames="created_by"
+                                 baseTableName="m_external_asset_owner_transfer_details"
+                                 constraintName="FK_external_asset_owner_transfer_details_created_by" deferrable="false"
+                                 initiallyDeferred="false"
+                                 onDelete="RESTRICT" onUpdate="RESTRICT" referencedColumnNames="id"
+                                 referencedTableName="m_appuser" validate="true"/>
+        <addForeignKeyConstraint baseColumnNames="last_modified_by"
+                                 baseTableName="m_external_asset_owner_transfer_details"
+                                 constraintName="FK_external_asset_owner_transfer_details_modified_by" deferrable="false"
+                                 initiallyDeferred="false"
+                                 onDelete="RESTRICT" onUpdate="RESTRICT" referencedColumnNames="id"
+                                 referencedTableName="m_appuser" validate="true"/>
+    </changeSet>
+
+</databaseChangeLog>
@@ -167,6 +167,8 @@ public class LoanAccountOwnerTransferBusinessStepTest {
        // given
        final Loan loanForProcessing = Mockito.mock(Loan.class);
        when(loanForProcessing.getId()).thenReturn(1L);
+        LoanSummary loanSummary = Mockito.mock(LoanSummary.class);
+        when(loanForProcessing.getLoanSummary()).thenReturn(loanSummary);
        ExternalAssetOwnerTransfer firstResponseItem = Mockito.mock(ExternalAssetOwnerTransfer.class);
        ExternalAssetOwnerTransfer secondResponseItem = Mockito.mock(ExternalAssetOwnerTransfer.class);
        when(firstResponseItem.getStatus()).thenReturn(ExternalTransferStatus.BUYBACK);