Package cdm.product.asset.floatingrate.functions

Class CapRateAmount

java.lang.Object

cdm.product.asset.floatingrate.functions.CapRateAmount

All Implemented Interfaces:

com.rosetta.model.lib.functions.RosettaFunction

Direct Known Subclasses:

CapRateAmount.CapRateAmountDefault

public abstract class CapRateAmount
extends Object
implements com.rosetta.model.lib.functions.RosettaFunction

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CapRateAmount.CapRateAmountDefault

Field Summary

Fields

Modifier and Type	Field	Description
protected GetRateScheduleAmount	getRateScheduleAmount

Constructor Summary

Constructors

Constructor	Description
CapRateAmount()

Method Summary

Modifier and Type	Method	Description
protected abstract BigDecimal	doEvaluate(InterestRatePayout interestRatePayout, CalculationPeriodBase calculationPeriod)
BigDecimal	evaluate(InterestRatePayout interestRatePayout, CalculationPeriodBase calculationPeriod)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.rosetta.model.lib.functions.RosettaFunction

toBuilder, toBuilder, toBuilder

Field Details

getRateScheduleAmount

@Inject
protected GetRateScheduleAmount getRateScheduleAmount

Constructor Details

CapRateAmount

public CapRateAmount()

Method Details

evaluate

public BigDecimal evaluate(InterestRatePayout interestRatePayout,
 CalculationPeriodBase calculationPeriod)

Parameters:

interestRatePayout - An interest rate stream.

calculationPeriod - The calculation period for which you want the cap rate.

Returns:

capRate The cap rate in effect from the calculation period start date.

doEvaluate

protected abstract BigDecimal doEvaluate(InterestRatePayout interestRatePayout,
 CalculationPeriodBase calculationPeriod)