WorkoutInfo

java.lang.Object

org.drip.param.valuation.WorkoutInfo

public class WorkoutInfo
extends java.lang.Object

WorkoutInfo is the place-holder for the work-out parameters. It contains the date, the factor, the type, and the yield of the work-out.

Module = Product Core Module
Library = Fixed Income Analytics
Project = Product Cash Flow, Valuation, Market, Pricing, and Quoting Parameters
Package = Valuation Settlement and Valuation Customization Parameters

Author:: Lakshmi Krishnamurthy

Field Summary

Fields

Modifier and Type Field Description

static int WO_TYPE_CALL
Work out type Call

static int WO_TYPE_MATURITY
Work out type Maturity

static int WO_TYPE_PUT
Work out type Put

Constructor Summary

Constructors
Constructor	Description
`WorkoutInfo(int iDate, double dblYield, double dblExerciseFactor, int iWOType)`	Constructor: Construct the class from the work-out date, yield, exercise factor, and type

Method Summary

Modifier and Type	Method	Description
`int`	`date()`	Retrieve the Work-out Date
`double`	`factor()`	Retrieve the Work-out Factor
`int`	`type()`	Retrieve the Work-out Type
`double`	`yield()`	Retrieve the Work-out Yield

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- WO_TYPE_CALL
  
  public static final int WO_TYPE_CALL
  
  Work out type Call
  
  See Also:
  
  Constant Field Values
- WO_TYPE_PUT
  
  public static final int WO_TYPE_PUT
  
  Work out type Put
  
  See Also:
  
  Constant Field Values
- WO_TYPE_MATURITY
  
  public static final int WO_TYPE_MATURITY
  
  Work out type Maturity
  
  See Also:
  
  Constant Field Values
Constructor Details
- WorkoutInfo
  
  public WorkoutInfo(int iDate, double dblYield, double dblExerciseFactor, int iWOType) throws java.lang.Exception
  
  Constructor: Construct the class from the work-out date, yield, exercise factor, and type
  
  Parameters:
  
  iDate - Work-out Date
  
  dblYield - Work-out Yield
  
  dblExerciseFactor - Work-out Factor
  
  iWOType - Work out Type
  
  Throws:
  
  java.lang.Exception - Thrown if input is invalid
Method Details
- date
  
  public int date()
  
  Retrieve the Work-out Date
  
  Returns:
  
  The Work-out Date
- yield
  
  public double yield()
  
  Retrieve the Work-out Yield
  
  Returns:
  
  The Work-out Yield
- factor
  
  public double factor()
  
  Retrieve the Work-out Factor
  
  Returns:
  
  The Work-out Factor
- type
  
  public int type()
  
  Retrieve the Work-out Type
  
  Returns:
  
  The Work-out Type