Package cdm.product.common.schedule

Class PaymentCalculationPeriod.PaymentCalculationPeriodImpl

java.lang.Object

cdm.product.common.schedule.PaymentCalculationPeriod.PaymentCalculationPeriodImpl

All Implemented Interfaces:

PaymentCalculationPeriod, com.rosetta.model.lib.GlobalKey, com.rosetta.model.lib.RosettaModelObject

Enclosing interface:

PaymentCalculationPeriod

public static class PaymentCalculationPeriod.PaymentCalculationPeriodImpl
extends Object
implements PaymentCalculationPeriod

Immutable Implementation of PaymentCalculationPeriod

Nested Class Summary

Nested classes/interfaces inherited from interface com.rosetta.model.lib.GlobalKey

com.rosetta.model.lib.GlobalKey.GlobalKeyBuilder

Nested classes/interfaces inherited from interface cdm.product.common.schedule.PaymentCalculationPeriod

PaymentCalculationPeriod.PaymentCalculationPeriodBuilder, PaymentCalculationPeriod.PaymentCalculationPeriodBuilderImpl, PaymentCalculationPeriod.PaymentCalculationPeriodImpl

Field Summary

Fields inherited from interface cdm.product.common.schedule.PaymentCalculationPeriod

metaData

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PaymentCalculationPeriodImpl(PaymentCalculationPeriod.PaymentCalculationPeriodBuilder builder)

Method Summary

Modifier and Type	Method	Description
PaymentCalculationPeriod	build()	Build Methods
boolean	equals(Object o)
com.rosetta.model.lib.records.Date	getAdjustedPaymentDate()	The adjusted payment date.
List<? extends CalculationPeriod>	getCalculationPeriod()	The parameters used in the calculation of a fixed or floating rate calculation period amount.
BigDecimal	getDiscountFactor()	A decimal value representing the discount factor used to calculate the present value of cash flow.
Money	getFixedPaymentAmount()	A known fixed payment amount.
Money	getForecastPaymentAmount()	A monetary amount representing the forecast of the future value of the payment.
com.rosetta.model.metafields.MetaFields	getMeta()
Money	getPresentValueAmount()	A monetary amount representing the present value of the forecast payment.
com.rosetta.model.lib.records.Date	getUnadjustedPaymentDate()	The unadjusted payment date.
int	hashCode()
protected void	setBuilderFields(PaymentCalculationPeriod.PaymentCalculationPeriodBuilder builder)
PaymentCalculationPeriod.PaymentCalculationPeriodBuilder	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface cdm.product.common.schedule.PaymentCalculationPeriod

getType, metaData, process

Methods inherited from interface com.rosetta.model.lib.RosettaModelObject

processRosetta, processRosetta

Constructor Details

PaymentCalculationPeriodImpl

protected PaymentCalculationPeriodImpl(PaymentCalculationPeriod.PaymentCalculationPeriodBuilder builder)

Method Details

getUnadjustedPaymentDate

@RosettaAttribute("unadjustedPaymentDate")
@RuneAttribute("unadjustedPaymentDate")
public com.rosetta.model.lib.records.Date getUnadjustedPaymentDate()

Description copied from interface: PaymentCalculationPeriod

The unadjusted payment date.

Specified by:

getUnadjustedPaymentDate in interface PaymentCalculationPeriod

getAdjustedPaymentDate

@RosettaAttribute("adjustedPaymentDate")
@RuneAttribute("adjustedPaymentDate")
public com.rosetta.model.lib.records.Date getAdjustedPaymentDate()

Description copied from interface: PaymentCalculationPeriod

The adjusted payment date. This date should already be adjusted for any applicable business day convention. This component is not intended for use in trade confirmation but may be specified to allow the fee structure to also serve as a cashflow type component.

Specified by:

getAdjustedPaymentDate in interface PaymentCalculationPeriod

getCalculationPeriod

@RosettaAttribute(value="calculationPeriod",
                  isRequired=true)
@RuneAttribute(value="calculationPeriod",
               isRequired=true)
public List<? extends CalculationPeriod> getCalculationPeriod()

Description copied from interface: PaymentCalculationPeriod

The parameters used in the calculation of a fixed or floating rate calculation period amount. A list of calculation period elements may be ordered in the document by ascending start date. An FpML document which contains an unordered list of calculation periods is still regarded as a conformant document.

Specified by:

getCalculationPeriod in interface PaymentCalculationPeriod

getFixedPaymentAmount

@RosettaAttribute("fixedPaymentAmount")
@RuneAttribute("fixedPaymentAmount")
public Money getFixedPaymentAmount()

Description copied from interface: PaymentCalculationPeriod

A known fixed payment amount.

Specified by:

getFixedPaymentAmount in interface PaymentCalculationPeriod

getDiscountFactor

@RosettaAttribute("discountFactor")
@RuneAttribute("discountFactor")
public BigDecimal getDiscountFactor()

Description copied from interface: PaymentCalculationPeriod

A decimal value representing the discount factor used to calculate the present value of cash flow.

Specified by:

getDiscountFactor in interface PaymentCalculationPeriod

getForecastPaymentAmount

@RosettaAttribute("forecastPaymentAmount")
@RuneAttribute("forecastPaymentAmount")
public Money getForecastPaymentAmount()

Description copied from interface: PaymentCalculationPeriod

A monetary amount representing the forecast of the future value of the payment.

Specified by:

getForecastPaymentAmount in interface PaymentCalculationPeriod

getPresentValueAmount

@RosettaAttribute("presentValueAmount")
@RuneAttribute("presentValueAmount")
public Money getPresentValueAmount()

Description copied from interface: PaymentCalculationPeriod

A monetary amount representing the present value of the forecast payment.

Specified by:

getPresentValueAmount in interface PaymentCalculationPeriod

getMeta

@RosettaAttribute("meta")
@RuneAttribute("meta")
@RuneMetaType
public com.rosetta.model.metafields.MetaFields getMeta()

Specified by:

getMeta in interface com.rosetta.model.lib.GlobalKey

Specified by:

getMeta in interface PaymentCalculationPeriod

build

public PaymentCalculationPeriod build()

Description copied from interface: PaymentCalculationPeriod

Build Methods

Specified by:

build in interface PaymentCalculationPeriod

Specified by:

build in interface com.rosetta.model.lib.RosettaModelObject

toBuilder

public PaymentCalculationPeriod.PaymentCalculationPeriodBuilder toBuilder()

Specified by:

toBuilder in interface PaymentCalculationPeriod

Specified by:

toBuilder in interface com.rosetta.model.lib.RosettaModelObject

setBuilderFields

protected void setBuilderFields(PaymentCalculationPeriod.PaymentCalculationPeriodBuilder builder)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object