Package cdm.product.common.schedule

Class PaymentCalculationPeriod.PaymentCalculationPeriodBuilderImpl

java.lang.Object

cdm.product.common.schedule.PaymentCalculationPeriod.PaymentCalculationPeriodBuilderImpl

All Implemented Interfaces:

PaymentCalculationPeriod, PaymentCalculationPeriod.PaymentCalculationPeriodBuilder, com.rosetta.model.lib.GlobalKey, com.rosetta.model.lib.GlobalKey.GlobalKeyBuilder, com.rosetta.model.lib.RosettaModelObject, com.rosetta.model.lib.RosettaModelObjectBuilder

Enclosing interface:

PaymentCalculationPeriod

public static class PaymentCalculationPeriod.PaymentCalculationPeriodBuilderImpl
extends Object
implements PaymentCalculationPeriod.PaymentCalculationPeriodBuilder

Builder 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

Modifier and Type	Field	Description
protected com.rosetta.model.lib.records.Date	adjustedPaymentDate
protected List<CalculationPeriod.CalculationPeriodBuilder>	calculationPeriod
protected BigDecimal	discountFactor
protected Money.MoneyBuilder	fixedPaymentAmount
protected Money.MoneyBuilder	forecastPaymentAmount
protected com.rosetta.model.metafields.MetaFields.MetaFieldsBuilder	meta
protected Money.MoneyBuilder	presentValueAmount
protected com.rosetta.model.lib.records.Date	unadjustedPaymentDate

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

metaData

Constructor Summary

Constructors

Constructor	Description
PaymentCalculationPeriodBuilderImpl()

Method Summary

Modifier and Type	Method	Description
PaymentCalculationPeriod.PaymentCalculationPeriodBuilder	addCalculationPeriod(CalculationPeriod _calculationPeriod)
PaymentCalculationPeriod.PaymentCalculationPeriodBuilder	addCalculationPeriod(CalculationPeriod _calculationPeriod, int idx)
PaymentCalculationPeriod.PaymentCalculationPeriodBuilder	addCalculationPeriod(List<? extends CalculationPeriod> calculationPeriods)
PaymentCalculationPeriod	build()	Build Methods
boolean	equals(Object o)
com.rosetta.model.lib.records.Date	getAdjustedPaymentDate()	The adjusted payment date.
List<? extends CalculationPeriod.CalculationPeriodBuilder>	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.MoneyBuilder	getFixedPaymentAmount()	A known fixed payment amount.
Money.MoneyBuilder	getForecastPaymentAmount()	A monetary amount representing the forecast of the future value of the payment.
com.rosetta.model.metafields.MetaFields.MetaFieldsBuilder	getMeta()
CalculationPeriod.CalculationPeriodBuilder	getOrCreateCalculationPeriod(int index)
Money.MoneyBuilder	getOrCreateFixedPaymentAmount()
Money.MoneyBuilder	getOrCreateForecastPaymentAmount()
com.rosetta.model.metafields.MetaFields.MetaFieldsBuilder	getOrCreateMeta()
Money.MoneyBuilder	getOrCreatePresentValueAmount()
Money.MoneyBuilder	getPresentValueAmount()	A monetary amount representing the present value of the forecast payment.
com.rosetta.model.lib.records.Date	getUnadjustedPaymentDate()	The unadjusted payment date.
boolean	hasData()
int	hashCode()
PaymentCalculationPeriod.PaymentCalculationPeriodBuilder	merge(com.rosetta.model.lib.RosettaModelObjectBuilder other, com.rosetta.model.lib.process.BuilderMerger merger)
PaymentCalculationPeriod.PaymentCalculationPeriodBuilder	prune()
PaymentCalculationPeriod.PaymentCalculationPeriodBuilder	setAdjustedPaymentDate(com.rosetta.model.lib.records.Date _adjustedPaymentDate)
PaymentCalculationPeriod.PaymentCalculationPeriodBuilder	setCalculationPeriod(List<? extends CalculationPeriod> calculationPeriods)
PaymentCalculationPeriod.PaymentCalculationPeriodBuilder	setDiscountFactor(BigDecimal _discountFactor)
PaymentCalculationPeriod.PaymentCalculationPeriodBuilder	setFixedPaymentAmount(Money _fixedPaymentAmount)
PaymentCalculationPeriod.PaymentCalculationPeriodBuilder	setForecastPaymentAmount(Money _forecastPaymentAmount)
PaymentCalculationPeriod.PaymentCalculationPeriodBuilder	setMeta(com.rosetta.model.metafields.MetaFields _meta)
PaymentCalculationPeriod.PaymentCalculationPeriodBuilder	setPresentValueAmount(Money _presentValueAmount)
PaymentCalculationPeriod.PaymentCalculationPeriodBuilder	setUnadjustedPaymentDate(com.rosetta.model.lib.records.Date _unadjustedPaymentDate)
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 cdm.product.common.schedule.PaymentCalculationPeriod.PaymentCalculationPeriodBuilder

process

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

processRosetta, processRosetta

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

getIndex, processRosetta, processRosetta

Field Details

unadjustedPaymentDate

protected com.rosetta.model.lib.records.Date unadjustedPaymentDate

adjustedPaymentDate

protected com.rosetta.model.lib.records.Date adjustedPaymentDate

calculationPeriod

protected List<CalculationPeriod.CalculationPeriodBuilder> calculationPeriod

fixedPaymentAmount

protected Money.MoneyBuilder fixedPaymentAmount

discountFactor

protected BigDecimal discountFactor

forecastPaymentAmount

protected Money.MoneyBuilder forecastPaymentAmount

presentValueAmount

protected Money.MoneyBuilder presentValueAmount

meta

protected com.rosetta.model.metafields.MetaFields.MetaFieldsBuilder meta

Constructor Details

PaymentCalculationPeriodBuilderImpl

public PaymentCalculationPeriodBuilderImpl()

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.CalculationPeriodBuilder> 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

Specified by:

getCalculationPeriod in interface PaymentCalculationPeriod.PaymentCalculationPeriodBuilder

getOrCreateCalculationPeriod

public CalculationPeriod.CalculationPeriodBuilder getOrCreateCalculationPeriod(int index)

Specified by:

getOrCreateCalculationPeriod in interface PaymentCalculationPeriod.PaymentCalculationPeriodBuilder

getFixedPaymentAmount

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

Description copied from interface: PaymentCalculationPeriod

A known fixed payment amount.

Specified by:

getFixedPaymentAmount in interface PaymentCalculationPeriod

Specified by:

getFixedPaymentAmount in interface PaymentCalculationPeriod.PaymentCalculationPeriodBuilder

getOrCreateFixedPaymentAmount

public Money.MoneyBuilder getOrCreateFixedPaymentAmount()

Specified by:

getOrCreateFixedPaymentAmount in interface PaymentCalculationPeriod.PaymentCalculationPeriodBuilder

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.MoneyBuilder 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

Specified by:

getForecastPaymentAmount in interface PaymentCalculationPeriod.PaymentCalculationPeriodBuilder

getOrCreateForecastPaymentAmount

public Money.MoneyBuilder getOrCreateForecastPaymentAmount()

Specified by:

getOrCreateForecastPaymentAmount in interface PaymentCalculationPeriod.PaymentCalculationPeriodBuilder

getPresentValueAmount

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

Description copied from interface: PaymentCalculationPeriod

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

Specified by:

getPresentValueAmount in interface PaymentCalculationPeriod

Specified by:

getPresentValueAmount in interface PaymentCalculationPeriod.PaymentCalculationPeriodBuilder

getOrCreatePresentValueAmount

public Money.MoneyBuilder getOrCreatePresentValueAmount()

Specified by:

getOrCreatePresentValueAmount in interface PaymentCalculationPeriod.PaymentCalculationPeriodBuilder

getMeta

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

Specified by:

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

Specified by:

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

Specified by:

getMeta in interface PaymentCalculationPeriod

Specified by:

getMeta in interface PaymentCalculationPeriod.PaymentCalculationPeriodBuilder

getOrCreateMeta

public com.rosetta.model.metafields.MetaFields.MetaFieldsBuilder getOrCreateMeta()

Specified by:

getOrCreateMeta in interface com.rosetta.model.lib.GlobalKey.GlobalKeyBuilder

Specified by:

getOrCreateMeta in interface PaymentCalculationPeriod.PaymentCalculationPeriodBuilder

setUnadjustedPaymentDate

@RosettaAttribute("unadjustedPaymentDate")
@RuneAttribute("unadjustedPaymentDate")
public PaymentCalculationPeriod.PaymentCalculationPeriodBuilder setUnadjustedPaymentDate(com.rosetta.model.lib.records.Date _unadjustedPaymentDate)

Specified by:

setUnadjustedPaymentDate in interface PaymentCalculationPeriod.PaymentCalculationPeriodBuilder

setAdjustedPaymentDate

@RosettaAttribute("adjustedPaymentDate")
@RuneAttribute("adjustedPaymentDate")
public PaymentCalculationPeriod.PaymentCalculationPeriodBuilder setAdjustedPaymentDate(com.rosetta.model.lib.records.Date _adjustedPaymentDate)

Specified by:

setAdjustedPaymentDate in interface PaymentCalculationPeriod.PaymentCalculationPeriodBuilder

addCalculationPeriod

@RosettaAttribute(value="calculationPeriod",
                  isRequired=true)
@RuneAttribute(value="calculationPeriod",
               isRequired=true)
public PaymentCalculationPeriod.PaymentCalculationPeriodBuilder addCalculationPeriod(CalculationPeriod _calculationPeriod)

Specified by:

addCalculationPeriod in interface PaymentCalculationPeriod.PaymentCalculationPeriodBuilder

addCalculationPeriod

public PaymentCalculationPeriod.PaymentCalculationPeriodBuilder addCalculationPeriod(CalculationPeriod _calculationPeriod,
 int idx)

Specified by:

addCalculationPeriod in interface PaymentCalculationPeriod.PaymentCalculationPeriodBuilder

addCalculationPeriod

public PaymentCalculationPeriod.PaymentCalculationPeriodBuilder addCalculationPeriod(List<? extends CalculationPeriod> calculationPeriods)

Specified by:

addCalculationPeriod in interface PaymentCalculationPeriod.PaymentCalculationPeriodBuilder

setCalculationPeriod

@RuneAttribute("calculationPeriod")
public PaymentCalculationPeriod.PaymentCalculationPeriodBuilder setCalculationPeriod(List<? extends CalculationPeriod> calculationPeriods)

Specified by:

setCalculationPeriod in interface PaymentCalculationPeriod.PaymentCalculationPeriodBuilder

setFixedPaymentAmount

@RosettaAttribute("fixedPaymentAmount")
@RuneAttribute("fixedPaymentAmount")
public PaymentCalculationPeriod.PaymentCalculationPeriodBuilder setFixedPaymentAmount(Money _fixedPaymentAmount)

Specified by:

setFixedPaymentAmount in interface PaymentCalculationPeriod.PaymentCalculationPeriodBuilder

setDiscountFactor

@RosettaAttribute("discountFactor")
@RuneAttribute("discountFactor")
public PaymentCalculationPeriod.PaymentCalculationPeriodBuilder setDiscountFactor(BigDecimal _discountFactor)

Specified by:

setDiscountFactor in interface PaymentCalculationPeriod.PaymentCalculationPeriodBuilder

setForecastPaymentAmount

@RosettaAttribute("forecastPaymentAmount")
@RuneAttribute("forecastPaymentAmount")
public PaymentCalculationPeriod.PaymentCalculationPeriodBuilder setForecastPaymentAmount(Money _forecastPaymentAmount)

Specified by:

setForecastPaymentAmount in interface PaymentCalculationPeriod.PaymentCalculationPeriodBuilder

setPresentValueAmount

@RosettaAttribute("presentValueAmount")
@RuneAttribute("presentValueAmount")
public PaymentCalculationPeriod.PaymentCalculationPeriodBuilder setPresentValueAmount(Money _presentValueAmount)

Specified by:

setPresentValueAmount in interface PaymentCalculationPeriod.PaymentCalculationPeriodBuilder

setMeta

@RosettaAttribute("meta")
@RuneAttribute("meta")
@RuneMetaType
public PaymentCalculationPeriod.PaymentCalculationPeriodBuilder setMeta(com.rosetta.model.metafields.MetaFields _meta)

Specified by:

setMeta in interface PaymentCalculationPeriod.PaymentCalculationPeriodBuilder

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

prune

public PaymentCalculationPeriod.PaymentCalculationPeriodBuilder prune()

Specified by:

prune in interface PaymentCalculationPeriod.PaymentCalculationPeriodBuilder

Specified by:

prune in interface com.rosetta.model.lib.RosettaModelObjectBuilder

hasData

public boolean hasData()

Specified by:

hasData in interface com.rosetta.model.lib.RosettaModelObjectBuilder

merge

public PaymentCalculationPeriod.PaymentCalculationPeriodBuilder merge(com.rosetta.model.lib.RosettaModelObjectBuilder other,
 com.rosetta.model.lib.process.BuilderMerger merger)

Specified by:

merge in interface com.rosetta.model.lib.RosettaModelObjectBuilder

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