/FileExtraction/Java_unseen/crisis-economics_CRISIS/CRISIS/src/eu/crisis_economics/abm/contracts/loans/FixedRateMortgage.java
/*
 * This file is part of CRISIS, an economics simulator.
 * 
 * Copyright (C) 2015 Ross Richardson
 * Copyright (C) 2015 John Kieran Phillips
 *
 * CRISIS is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * CRISIS is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with CRISIS.  If not, see <http://www.gnu.org/licenses/>.
 */
package eu.crisis_economics.abm.contracts.loans;

import eu.crisis_economics.abm.simulation.ScheduleIntervals;
import eu.crisis_economics.abm.simulation.SimulatedEventOrder;

/**
  * A Fixed Rate Mortgage (FRM) Loan Contract.
  * 
  * For FRM loan contracts, the Borrower repays to the Lender the 
  * same amount, C, every time a loan installment repayment is due.
  * 
  * C is determined by the following formula:
  *
  * C = fixed installment payment of (1+r)^N*P*r/((1+r)^N-1), where
  * r = the fixed mortgage interest rate;
  * N = the total number of loan repayment installments; and
  * P = the total amount borrowed from the Lender (the original principal).
  * 
  * For further reference, refer to "Fixed rate mortgage" on Wikipedia.
  * 
  * @author phillips
  */
public class FixedRateMortgage extends RepaymentPlanLoan {
   FixedRateMortgage(
      Borrower borrower,
      Lender lender,
      final double principalValue,
      final double interestRate,
      final int numberOfInstalments,
      SimulatedEventOrder repaymentOrder,
      ScheduleIntervals installmentInterval
      ) throws LenderInsufficientFundsException {
      super(
         borrower,
         lender,
         new FixedRateMortgageRepaymentScheme(
            principalValue,
            interestRate,
            numberOfInstalments,
            repaymentOrder,
            installmentInterval
            ),
         new LiquidateBorrowerDefaultScheme()
         );
   }
   
   @Override
   public <T> T acceptOperation(LoanOperation<T> operation) {
      return operation.operateOn(this);
   }
   
   /**
     * Returns a brief description of this object. The exact details of the
     * string are subject to change, and should not be regarded as fixed.
     */
   @Override
   public String toString() {
      return "FixedRateMortgage, value: " + getValue() + ", interest rate: "
            + getInterestRate() + ", next instalment: "
            + getNextInstallmentPayment() + ", principal value: "
            + getLoanPrincipalValue() + ".";
   }
}
