Package cdm.product.asset

Interface DividendReturnTerms.DividendReturnTermsBuilder

All Superinterfaces:

DividendReturnTerms, com.rosetta.model.lib.RosettaModelObject, com.rosetta.model.lib.RosettaModelObjectBuilder

All Known Implementing Classes:

DividendReturnTerms.DividendReturnTermsBuilderImpl

Enclosing interface:

DividendReturnTerms

public static interface DividendReturnTerms.DividendReturnTermsBuilder
extends DividendReturnTerms, com.rosetta.model.lib.RosettaModelObjectBuilder

Builder Interface

Nested Class Summary

Nested classes/interfaces inherited from interface cdm.product.asset.DividendReturnTerms

DividendReturnTerms.DividendReturnTermsBuilder, DividendReturnTerms.DividendReturnTermsBuilderImpl, DividendReturnTerms.DividendReturnTermsImpl

Field Summary

Fields inherited from interface cdm.product.asset.DividendReturnTerms

metaData

Method Summary

Modifier and Type	Method	Description
DividendReturnTerms.DividendReturnTermsBuilder	addDividendPayoutRatio(DividendPayoutRatio dividendPayoutRatio)
DividendReturnTerms.DividendReturnTermsBuilder	addDividendPayoutRatio(DividendPayoutRatio dividendPayoutRatio, int idx)
DividendReturnTerms.DividendReturnTermsBuilder	addDividendPayoutRatio(List<? extends DividendPayoutRatio> dividendPayoutRatio)
DividendReturnTerms.DividendReturnTermsBuilder	addDividendPeriod(DividendPeriod dividendPeriod)
DividendReturnTerms.DividendReturnTermsBuilder	addDividendPeriod(DividendPeriod dividendPeriod, int idx)
DividendReturnTerms.DividendReturnTermsBuilder	addDividendPeriod(List<? extends DividendPeriod> dividendPeriod)
DividendCurrency.DividendCurrencyBuilder	getDividendCurrency()	Specifies the currency in which the dividend will be denominated, e.g. the dividend currency, or a specified currency.
List<? extends DividendPayoutRatio.DividendPayoutRatioBuilder>	getDividendPayoutRatio()	Specifies the dividend payout ratio associated with each underlier.
List<? extends DividendPeriod.DividendPeriodBuilder>	getDividendPeriod()	One to many time bounded dividend payment periods, each with a dividend payment date per period.
DividendCurrency.DividendCurrencyBuilder	getOrCreateDividendCurrency()
DividendPayoutRatio.DividendPayoutRatioBuilder	getOrCreateDividendPayoutRatio(int index)
DividendPeriod.DividendPeriodBuilder	getOrCreateDividendPeriod(int index)
default void	process(com.rosetta.model.lib.path.RosettaPath path, com.rosetta.model.lib.process.BuilderProcessor processor)
DividendReturnTerms.DividendReturnTermsBuilder	prune()
DividendReturnTerms.DividendReturnTermsBuilder	setDividendAmountType(DividendAmountTypeEnum dividendAmountType)
DividendReturnTerms.DividendReturnTermsBuilder	setDividendComposition(DividendCompositionEnum dividendComposition)
DividendReturnTerms.DividendReturnTermsBuilder	setDividendCurrency(DividendCurrency dividendCurrency)
DividendReturnTerms.DividendReturnTermsBuilder	setDividendEntitlement(DividendEntitlementEnum dividendEntitlement)
DividendReturnTerms.DividendReturnTermsBuilder	setDividendPayoutRatio(List<? extends DividendPayoutRatio> dividendPayoutRatio)
DividendReturnTerms.DividendReturnTermsBuilder	setDividendPeriod(List<? extends DividendPeriod> dividendPeriod)
DividendReturnTerms.DividendReturnTermsBuilder	setDividendReinvestment(Boolean dividendReinvestment)
DividendReturnTerms.DividendReturnTermsBuilder	setExcessDividendAmount(DividendAmountTypeEnum excessDividendAmount)
DividendReturnTerms.DividendReturnTermsBuilder	setExtraordinaryDividendsParty(AncillaryRoleEnum extraordinaryDividendsParty)
DividendReturnTerms.DividendReturnTermsBuilder	setFirstOrSecondPeriod(DividendPeriodEnum firstOrSecondPeriod)
DividendReturnTerms.DividendReturnTermsBuilder	setMaterialDividend(Boolean materialDividend)
DividendReturnTerms.DividendReturnTermsBuilder	setNonCashDividendTreatment(NonCashDividendTreatmentEnum nonCashDividendTreatment)
DividendReturnTerms.DividendReturnTermsBuilder	setPerformance(String performance)
DividendReturnTerms.DividendReturnTermsBuilder	setSpecialDividends(Boolean specialDividends)

Methods inherited from interface cdm.product.asset.DividendReturnTerms

build, getDividendAmountType, getDividendComposition, getDividendEntitlement, getDividendReinvestment, getExcessDividendAmount, getExtraordinaryDividendsParty, getFirstOrSecondPeriod, getMaterialDividend, getNonCashDividendTreatment, getPerformance, getSpecialDividends, getType, metaData, process, toBuilder

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

processRosetta, processRosetta

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

getIndex, hasData, merge, processRosetta, processRosetta

Method Details

getOrCreateDividendPayoutRatio

DividendPayoutRatio.DividendPayoutRatioBuilder getOrCreateDividendPayoutRatio(int index)

getDividendPayoutRatio

List<? extends DividendPayoutRatio.DividendPayoutRatioBuilder> getDividendPayoutRatio()

Description copied from interface: DividendReturnTerms

Specifies the dividend payout ratio associated with each underlier. In FpML 5.10 the payout is positioned at the underlier level, although there is an intent to reconsider this approach and position it at the leg level. This is approach adopted by the CDM.

Specified by:

getDividendPayoutRatio in interface DividendReturnTerms

getOrCreateDividendCurrency

DividendCurrency.DividendCurrencyBuilder getOrCreateDividendCurrency()

getDividendCurrency

DividendCurrency.DividendCurrencyBuilder getDividendCurrency()

Description copied from interface: DividendReturnTerms

Specifies the currency in which the dividend will be denominated, e.g. the dividend currency, or a specified currency. This class is not specified as such in FpML, which makes use of the CurrencyAndDeterminationMethod.model to specify such terms.

Specified by:

getDividendCurrency in interface DividendReturnTerms

getOrCreateDividendPeriod

DividendPeriod.DividendPeriodBuilder getOrCreateDividendPeriod(int index)

getDividendPeriod

List<? extends DividendPeriod.DividendPeriodBuilder> getDividendPeriod()

Description copied from interface: DividendReturnTerms

One to many time bounded dividend payment periods, each with a dividend payment date per period.

Specified by:

getDividendPeriod in interface DividendReturnTerms

addDividendPayoutRatio

DividendReturnTerms.DividendReturnTermsBuilder addDividendPayoutRatio(DividendPayoutRatio dividendPayoutRatio)

addDividendPayoutRatio

DividendReturnTerms.DividendReturnTermsBuilder addDividendPayoutRatio(DividendPayoutRatio dividendPayoutRatio,
 int idx)

addDividendPayoutRatio

DividendReturnTerms.DividendReturnTermsBuilder addDividendPayoutRatio(List<? extends DividendPayoutRatio> dividendPayoutRatio)

setDividendPayoutRatio

DividendReturnTerms.DividendReturnTermsBuilder setDividendPayoutRatio(List<? extends DividendPayoutRatio> dividendPayoutRatio)

setDividendReinvestment

DividendReturnTerms.DividendReturnTermsBuilder setDividendReinvestment(Boolean dividendReinvestment)

setDividendEntitlement

DividendReturnTerms.DividendReturnTermsBuilder setDividendEntitlement(DividendEntitlementEnum dividendEntitlement)

setDividendAmountType

DividendReturnTerms.DividendReturnTermsBuilder setDividendAmountType(DividendAmountTypeEnum dividendAmountType)

setPerformance

DividendReturnTerms.DividendReturnTermsBuilder setPerformance(String performance)

setFirstOrSecondPeriod

DividendReturnTerms.DividendReturnTermsBuilder setFirstOrSecondPeriod(DividendPeriodEnum firstOrSecondPeriod)

setExtraordinaryDividendsParty

DividendReturnTerms.DividendReturnTermsBuilder setExtraordinaryDividendsParty(AncillaryRoleEnum extraordinaryDividendsParty)

setExcessDividendAmount

DividendReturnTerms.DividendReturnTermsBuilder setExcessDividendAmount(DividendAmountTypeEnum excessDividendAmount)

setDividendCurrency

DividendReturnTerms.DividendReturnTermsBuilder setDividendCurrency(DividendCurrency dividendCurrency)

setNonCashDividendTreatment

DividendReturnTerms.DividendReturnTermsBuilder setNonCashDividendTreatment(NonCashDividendTreatmentEnum nonCashDividendTreatment)

setDividendComposition

DividendReturnTerms.DividendReturnTermsBuilder setDividendComposition(DividendCompositionEnum dividendComposition)

setSpecialDividends

DividendReturnTerms.DividendReturnTermsBuilder setSpecialDividends(Boolean specialDividends)

setMaterialDividend

DividendReturnTerms.DividendReturnTermsBuilder setMaterialDividend(Boolean materialDividend)

addDividendPeriod

DividendReturnTerms.DividendReturnTermsBuilder addDividendPeriod(DividendPeriod dividendPeriod)

addDividendPeriod

DividendReturnTerms.DividendReturnTermsBuilder addDividendPeriod(DividendPeriod dividendPeriod,
 int idx)

addDividendPeriod

DividendReturnTerms.DividendReturnTermsBuilder addDividendPeriod(List<? extends DividendPeriod> dividendPeriod)

setDividendPeriod

DividendReturnTerms.DividendReturnTermsBuilder setDividendPeriod(List<? extends DividendPeriod> dividendPeriod)

process

default void process(com.rosetta.model.lib.path.RosettaPath path,
 com.rosetta.model.lib.process.BuilderProcessor processor)

Specified by:

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

prune

DividendReturnTerms.DividendReturnTermsBuilder prune()

Specified by:

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