com.ftlabs.fisa
Interface CPIFactory

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

DefaultCPIFactory

public interface CPIFactory
extends java.io.Serializable

This interface defines methods for retrieving CPI values for given dates and offsets.

Method Summary

double	getCPI(java.util.Date date) This method returns the CPI for the given Date.
double	getCPI(java.util.Date date, int monthOffset) This method returns the CPI for the given month offset from the given date.
double	getCPI(int year, int month) This method returns the CPI for the given year and month.
double	getCPI(int year, int month, int monthOffset) This method returns the CPI for the given month offset from year and month.
double	getIndexRatio(java.util.Date datedDate, java.util.Date settlementDate) Returns the index ratio for a given datedDate and settlementDate.

Method Detail

getCPI

double getCPI(int year,
              int month)

This method returns the CPI for the given year and month.

Parameters:

year - The year

month - The month

Returns:

CPI for the given year and month.

getCPI

double getCPI(int year,
              int month,
              int monthOffset)

This method returns the CPI for the given month offset from year and month.

Parameters:

year - The year

month - The month

monthOffset - Months from the given month.

Returns:

CPI for the given offset from year and month.

getCPI

double getCPI(java.util.Date date)

This method returns the CPI for the given Date.

Parameters:

date - A Date

Returns:

CPI for the given Date.

getCPI

double getCPI(java.util.Date date,
              int monthOffset)

This method returns the CPI for the given month offset from the given date.

Parameters:

date - A date

monthOffset - Months from the given month.

Returns:

CPI for the given offset from the given date.

getIndexRatio

double getIndexRatio(java.util.Date datedDate,
                     java.util.Date settlementDate)

Returns the index ratio for a given datedDate and settlementDate.

Parameters:

datedDate - The datedDate of the Security.

settlementDate - The settlementDate for a given transaction.

Returns:

The index ratio for the given datedDate and settlementDate.