Coupon

java.lang.Object

org.drip.loan.characteristics.Coupon

public class Coupon
extends java.lang.Object

Coupon contains the current Loan Annualized Coupon Rate and Frequency.

Module = Product Core Module
Library = Loan Analytics
Project = Borrower and Loan Level Characteristics
Package = Asset Backed Loan Level Characteristics

Author:: Lakshmi Krishnamurthy

Constructor Summary

Constructors

Constructor Description

Coupon(double dblRate, int iFrequency)
Coupon Constructor
Method Summary

Modifier and Type Method Description

int frequency()
Retrieve the Loan Coupon Frequency

double rate()
Retrieve the Loan Coupon Rate

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- Coupon
  
  public Coupon(double dblRate, int iFrequency) throws java.lang.Exception
  
  Coupon Constructor
  
  Parameters:
  
  dblRate - Loan Coupon Rate
  
  iFrequency - Loan Coupon Frequency
  
  Throws:
  
  java.lang.Exception - Thrown if the Inputs are Invalid
Method Details
- frequency
  
  public int frequency()
  
  Retrieve the Loan Coupon Frequency
  
  Returns:
  
  The Loan Coupon Frequency
- rate
  
  public double rate()
  
  Retrieve the Loan Coupon Rate
  
  Returns:
  
  The Loan Coupon Rate