/**
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this file,
* You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package org.mifosplatform.portfolio.savings.domain;
import static org.mifosplatform.portfolio.interestratechart.InterestRateChartApiConstants.deleteParamName;
import static org.mifosplatform.portfolio.interestratechart.InterestRateChartApiConstants.idParamName;
import static org.mifosplatform.portfolio.savings.DepositsApiConstants.FIXED_DEPOSIT_PRODUCT_RESOURCE_NAME;
import static org.mifosplatform.portfolio.savings.DepositsApiConstants.maxDepositTermParamName;
import java.math.BigDecimal;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashMap;
import java.util.HashSet;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import javax.persistence.CascadeType;
import javax.persistence.DiscriminatorValue;
import javax.persistence.Entity;
import javax.persistence.FetchType;
import javax.persistence.JoinColumn;
import javax.persistence.JoinTable;
import javax.persistence.OneToMany;
import javax.persistence.OneToOne;
import javax.persistence.Transient;
import org.joda.time.LocalDate;
import org.mifosplatform.accounting.common.AccountingRuleType;
import org.mifosplatform.infrastructure.core.api.JsonCommand;
import org.mifosplatform.infrastructure.core.data.ApiParameterError;
import org.mifosplatform.infrastructure.core.data.DataValidatorBuilder;
import org.mifosplatform.infrastructure.core.exception.PlatformApiDataValidationException;
import org.mifosplatform.organisation.monetary.domain.MonetaryCurrency;
import org.mifosplatform.portfolio.charge.domain.Charge;
import org.mifosplatform.portfolio.interestratechart.InterestRateChartApiConstants;
import org.mifosplatform.portfolio.interestratechart.domain.InterestRateChart;
import org.mifosplatform.portfolio.interestratechart.service.InterestRateChartAssembler;
import org.mifosplatform.portfolio.savings.DepositsApiConstants;
import org.mifosplatform.portfolio.savings.SavingsCompoundingInterestPeriodType;
import org.mifosplatform.portfolio.savings.SavingsInterestCalculationDaysInYearType;
import org.mifosplatform.portfolio.savings.SavingsInterestCalculationType;
import org.mifosplatform.portfolio.savings.SavingsPeriodFrequencyType;
import org.mifosplatform.portfolio.savings.SavingsPostingInterestPeriodType;
import com.google.gson.JsonArray;
import com.google.gson.JsonObject;
@Entity
@DiscriminatorValue("200")
public class FixedDepositProduct extends SavingsProduct {
@OneToOne(mappedBy = "product", cascade = CascadeType.ALL)
private DepositProductTermAndPreClosure productTermAndPreClosure;
@OneToMany(fetch = FetchType.LAZY, cascade = CascadeType.ALL)
@JoinTable(name = "m_deposit_product_interest_rate_chart", joinColumns = @JoinColumn(name = "deposit_product_id"), inverseJoinColumns = @JoinColumn(name = "interest_rate_chart_id", unique = true))
protected Set<InterestRateChart> charts;
@Transient
protected InterestRateChartAssembler chartAssembler;
protected FixedDepositProduct() {
super();
}
public static FixedDepositProduct createNew(final String name, final String shortName, final String description,
final MonetaryCurrency currency, final BigDecimal interestRate,
final SavingsCompoundingInterestPeriodType interestCompoundingPeriodType,
final SavingsPostingInterestPeriodType interestPostingPeriodType, final SavingsInterestCalculationType interestCalculationType,
final SavingsInterestCalculationDaysInYearType interestCalculationDaysInYearType, final Integer lockinPeriodFrequency,
final SavingsPeriodFrequencyType lockinPeriodFrequencyType, final AccountingRuleType accountingRuleType,
final Set<Charge> charges, final DepositProductTermAndPreClosure productTermAndPreClosure, final Set<InterestRateChart> charts,
BigDecimal minBalanceForInterestCalculation) {
final BigDecimal minRequiredOpeningBalance = null;
final boolean withdrawalFeeApplicableForTransfer = false;
final boolean allowOverdraft = false;
final BigDecimal overdraftLimit = null;
return new FixedDepositProduct(name, shortName, description, currency, interestRate, interestCompoundingPeriodType,
interestPostingPeriodType, interestCalculationType, interestCalculationDaysInYearType, minRequiredOpeningBalance,
lockinPeriodFrequency, lockinPeriodFrequencyType, withdrawalFeeApplicableForTransfer, accountingRuleType, charges,
productTermAndPreClosure, charts, allowOverdraft, overdraftLimit, minBalanceForInterestCalculation);
}
protected FixedDepositProduct(final String name, final String shortName, final String description, final MonetaryCurrency currency,
final BigDecimal interestRate, final SavingsCompoundingInterestPeriodType interestCompoundingPeriodType,
final SavingsPostingInterestPeriodType interestPostingPeriodType, final SavingsInterestCalculationType interestCalculationType,
final SavingsInterestCalculationDaysInYearType interestCalculationDaysInYearType, final BigDecimal minRequiredOpeningBalance,
final Integer lockinPeriodFrequency, final SavingsPeriodFrequencyType lockinPeriodFrequencyType,
final boolean withdrawalFeeApplicableForTransfer, final AccountingRuleType accountingRuleType, final Set<Charge> charges,
final DepositProductTermAndPreClosure productTermAndPreClosure, final Set<InterestRateChart> charts,
final boolean allowOverdraft, final BigDecimal overdraftLimit, final BigDecimal minBalanceForInterestCalculation) {
super(name, shortName, description, currency, interestRate, interestCompoundingPeriodType, interestPostingPeriodType,
interestCalculationType, interestCalculationDaysInYearType, minRequiredOpeningBalance, lockinPeriodFrequency,
lockinPeriodFrequencyType, withdrawalFeeApplicableForTransfer, accountingRuleType, charges, allowOverdraft, overdraftLimit,
minBalanceForInterestCalculation);
if (charts != null) {
this.charts = charts;
}
this.productTermAndPreClosure = productTermAndPreClosure;
}
public void addCharts(final Set<InterestRateChart> newCharts) {
final Set<InterestRateChart> existingCharts = setOfCharts();
existingCharts.addAll(newCharts);
}
public void addChart(final InterestRateChart newChart) {
final Set<InterestRateChart> existingCharts = setOfCharts();
existingCharts.add(newChart);
}
public Set<InterestRateChart> setOfCharts() {
if (this.charts == null) {
this.charts = new HashSet<>();
}
return this.charts;
}
@Override
public Map<String, Object> update(final JsonCommand command) {
final Map<String, Object> actualChanges = new LinkedHashMap<>(10);
final List<ApiParameterError> dataValidationErrors = new ArrayList<>();
final DataValidatorBuilder baseDataValidator = new DataValidatorBuilder(dataValidationErrors)
.resource(FIXED_DEPOSIT_PRODUCT_RESOURCE_NAME);
actualChanges.putAll(this.update(command, baseDataValidator));
validateDomainRules(baseDataValidator);
throwExceptionIfValidationWarningsExist(dataValidationErrors);
return actualChanges;
}
protected Map<String, Object> update(final JsonCommand command, final DataValidatorBuilder baseDataValidator) {
final Map<String, Object> actualChanges = new LinkedHashMap<>(10);
actualChanges.putAll(super.update(command));
if (this.productTermAndPreClosure != null) {
actualChanges.putAll(this.productTermAndPreClosure.update(command, baseDataValidator));
}
// update chart Slabs
if (command.hasParameter(DepositsApiConstants.chartsParamName)) {
updateCharts(command, actualChanges, baseDataValidator);
}
return actualChanges;
}
private void updateCharts(JsonCommand command, Map<String, Object> actualChanges, final DataValidatorBuilder baseDataValidator) {
final Map<String, Object> deletedCharts = new HashMap<>();
final Map<String, Object> chartsChanges = new HashMap<>();
if (command.hasParameter(DepositsApiConstants.chartsParamName)) {
final JsonArray array = command.arrayOfParameterNamed(DepositsApiConstants.chartsParamName);
if (array != null) {
for (int i = 0; i < array.size(); i++) {
final JsonObject chartElement = array.get(i).getAsJsonObject();
JsonCommand chartCommand = JsonCommand.fromExistingCommand(command, chartElement);
if (chartCommand.parameterExists(idParamName)) {
final Long chartId = chartCommand.longValueOfParameterNamed(idParamName);
final InterestRateChart chart = this.findChart(chartId);
if (chart == null) {
baseDataValidator.parameter(idParamName).value(chartId).failWithCode("no.chart.associated.with.id");
} else if (chartCommand.parameterExists(deleteParamName)) {
if (this.removeChart(chart)) {
deletedCharts.put(idParamName, chartId);
}
} else {
chart.update(chartCommand, chartsChanges, baseDataValidator, this.setOfCharts(), this.currency().getCode());
}
} else {
// assemble chart
final InterestRateChart newChart = this.chartAssembler.assembleFrom(chartElement, this.currency().getCode());
this.addChart(newChart);
}
}
}
}
// this.validateCharts(baseDataValidator);
// add chart changes to actual changes list.
if (!chartsChanges.isEmpty()) {
actualChanges.put(InterestRateChartApiConstants.chartSlabs, chartsChanges);
}
// add deleted chart to actual changes
if (!deletedCharts.isEmpty()) {
actualChanges.put("deletedChartSlabs", deletedCharts);
}
}
private void throwExceptionIfValidationWarningsExist(final List<ApiParameterError> dataValidationErrors) {
if (!dataValidationErrors.isEmpty()) { throw new PlatformApiDataValidationException(dataValidationErrors); }
}
@Override
public InterestRateChart findChart(Long chartId) {
final Set<InterestRateChart> charts = setOfCharts();
for (InterestRateChart chart : charts) {
if (chart.getId().equals(chartId)) { return chart; }
}
return null;
}
private boolean removeChart(InterestRateChart chart) {
Set<InterestRateChart> charts = setOfCharts();
return charts.remove(chart);
}
public void setHelpers(final InterestRateChartAssembler chartAssembler) {
this.chartAssembler = chartAssembler;
}
public void validateCharts(final DataValidatorBuilder baseDataValidator) {
final Set<InterestRateChart> charts = this.setOfCharts();
for (InterestRateChart existingChart : charts) {
this.validateChart(baseDataValidator, existingChart);
}
}
public void validateChart(final DataValidatorBuilder baseDataValidator, final InterestRateChart comparingChart) {
final Set<InterestRateChart> charts = this.setOfCharts();
for (InterestRateChart existingChart : charts) {
if (!existingChart.equals(comparingChart)) {
if (existingChart.chartFields().isOverlapping(comparingChart.chartFields())) {
baseDataValidator.failWithCodeNoParameterAddedToErrorCode("chart.overlapping.from.and.end.dates",
existingChart.getFromDateAsLocalDate(), existingChart.getEndDateAsLocalDate(),
comparingChart.getFromDateAsLocalDate(), comparingChart.getEndDateAsLocalDate());
}
}
}
}
@Override
public InterestRateChart applicableChart(final LocalDate target) {
InterestRateChart applicableChart = null;
if (this.charts != null) {
for (InterestRateChart chart : this.charts) {
if (chart.isApplicableChartFor(target)) {
applicableChart = chart;
break;
}
}
}
return applicableChart;
}
public DepositProductTermAndPreClosure depositProductTermAndPreClosure() {
return this.productTermAndPreClosure;
}
public void validateInterestPostingAndCompoundingPeriodTypes(final DataValidatorBuilder baseDataValidator) {
Map<SavingsPostingInterestPeriodType, List<SavingsCompoundingInterestPeriodType>> postingtoCompoundMap = new HashMap<>();
postingtoCompoundMap.put(
SavingsPostingInterestPeriodType.MONTHLY,
Arrays.asList(new SavingsCompoundingInterestPeriodType[] { SavingsCompoundingInterestPeriodType.DAILY,
SavingsCompoundingInterestPeriodType.MONTHLY }));
postingtoCompoundMap.put(
SavingsPostingInterestPeriodType.QUATERLY,
Arrays.asList(new SavingsCompoundingInterestPeriodType[] { SavingsCompoundingInterestPeriodType.DAILY,
SavingsCompoundingInterestPeriodType.MONTHLY, SavingsCompoundingInterestPeriodType.QUATERLY }));
postingtoCompoundMap.put(
SavingsPostingInterestPeriodType.BIANNUAL,
Arrays.asList(new SavingsCompoundingInterestPeriodType[] { SavingsCompoundingInterestPeriodType.DAILY,
SavingsCompoundingInterestPeriodType.MONTHLY, SavingsCompoundingInterestPeriodType.QUATERLY,
SavingsCompoundingInterestPeriodType.BI_ANNUAL }));
postingtoCompoundMap.put(
SavingsPostingInterestPeriodType.ANNUAL,
Arrays.asList(new SavingsCompoundingInterestPeriodType[] { SavingsCompoundingInterestPeriodType.DAILY,
SavingsCompoundingInterestPeriodType.MONTHLY, SavingsCompoundingInterestPeriodType.QUATERLY,
SavingsCompoundingInterestPeriodType.BI_ANNUAL, SavingsCompoundingInterestPeriodType.ANNUAL }));
SavingsPostingInterestPeriodType savingsPostingInterestPeriodType = SavingsPostingInterestPeriodType
.fromInt(interestPostingPeriodType);
SavingsCompoundingInterestPeriodType savingsCompoundingInterestPeriodType = SavingsCompoundingInterestPeriodType
.fromInt(interestCompoundingPeriodType);
if (postingtoCompoundMap.get(savingsPostingInterestPeriodType) == null
|| !postingtoCompoundMap.get(savingsPostingInterestPeriodType).contains(savingsCompoundingInterestPeriodType)) {
baseDataValidator.failWithCodeNoParameterAddedToErrorCode("posting.period.type.is.less.than.compound.period.type",
savingsPostingInterestPeriodType.name(), savingsCompoundingInterestPeriodType.name());
}
}
public void validateDomainRules() {
final List<ApiParameterError> dataValidationErrors = new ArrayList<>();
final DataValidatorBuilder baseDataValidator = new DataValidatorBuilder(dataValidationErrors)
.resource(FIXED_DEPOSIT_PRODUCT_RESOURCE_NAME);
validateDomainRules(baseDataValidator);
throwExceptionIfValidationWarningsExist(dataValidationErrors);
}
private void validateDomainRules(final DataValidatorBuilder baseDataValidator) {
final DepositTermDetail termDetails = this.depositProductTermAndPreClosure().depositTermDetail();
final boolean isMinTermGreaterThanMax = termDetails.isMinDepositTermGreaterThanMaxDepositTerm();
if (isMinTermGreaterThanMax) {
final Integer maxTerm = termDetails.maxDepositTerm();
baseDataValidator.reset().parameter(maxDepositTermParamName).value(maxTerm)
.failWithCodeNoParameterAddedToErrorCode("max.term.lessthan.min.term");
}
if (this.charts != null) {
validateCharts(baseDataValidator);
} else if (this.nominalAnnualInterestRate == null || this.nominalAnnualInterestRate.compareTo(BigDecimal.ZERO) == 0) {
baseDataValidator.reset().parameter(DepositsApiConstants.nominalAnnualInterestRateParamName).value(nominalAnnualInterestRate)
.failWithCodeNoParameterAddedToErrorCode("interest.chart.or.nominal.interest.rate.required");
}
this.validateInterestPostingAndCompoundingPeriodTypes(baseDataValidator);
}
}