Package cdm.product.asset

Class DividendReturnTerms.DividendReturnTermsBuilderImpl

java.lang.Object

cdm.product.asset.DividendReturnTerms.DividendReturnTermsBuilderImpl

All Implemented Interfaces:

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

Enclosing interface:

DividendReturnTerms

public static class DividendReturnTerms.DividendReturnTermsBuilderImpl
extends Object
implements DividendReturnTerms.DividendReturnTermsBuilder

Builder Implementation of DividendReturnTerms

Nested Class Summary

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

DividendReturnTerms.DividendReturnTermsBuilder, DividendReturnTerms.DividendReturnTermsBuilderImpl, DividendReturnTerms.DividendReturnTermsImpl

Field Summary

Fields

Modifier and Type	Field	Description
protected DividendAmountTypeEnum	dividendAmountType
protected DividendCompositionEnum	dividendComposition
protected DividendCurrency.DividendCurrencyBuilder	dividendCurrency
protected DividendEntitlementEnum	dividendEntitlement
protected List<DividendPayoutRatio.DividendPayoutRatioBuilder>	dividendPayoutRatio
protected List<DividendPeriod.DividendPeriodBuilder>	dividendPeriod
protected Boolean	dividendReinvestment
protected DividendAmountTypeEnum	excessDividendAmount
protected AncillaryRoleEnum	extraordinaryDividendsParty
protected DividendPeriodEnum	firstOrSecondPeriod
protected Boolean	materialDividend
protected NonCashDividendTreatmentEnum	nonCashDividendTreatment
protected String	performance
protected Boolean	specialDividends

Fields inherited from interface cdm.product.asset.DividendReturnTerms

metaData

Constructor Summary

Constructors

Constructor	Description
DividendReturnTermsBuilderImpl()

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> dividendPayoutRatios)
DividendReturnTerms.DividendReturnTermsBuilder	addDividendPeriod(DividendPeriod _dividendPeriod)
DividendReturnTerms.DividendReturnTermsBuilder	addDividendPeriod(DividendPeriod _dividendPeriod, int idx)
DividendReturnTerms.DividendReturnTermsBuilder	addDividendPeriod(List<? extends DividendPeriod> dividendPeriods)
DividendReturnTerms	build()	Build Methods
boolean	equals(Object o)
DividendAmountTypeEnum	getDividendAmountType()	Specifies whether the dividend is paid with respect to the Dividend Period.
DividendCompositionEnum	getDividendComposition()	Specifies how the composition of Dividends is to be determined.
DividendCurrency.DividendCurrencyBuilder	getDividendCurrency()	Specifies the currency in which the dividend will be denominated, e.g. the dividend currency, or a specified currency.
DividendEntitlementEnum	getDividendEntitlement()	Defines the date on which the receiver of the equity return is entitled to the dividend.
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.
Boolean	getDividendReinvestment()	Boolean element that defines whether the dividend will be reinvested or not.
DividendAmountTypeEnum	getExcessDividendAmount()	Determination of Gross Cash Dividend per Share.
AncillaryRoleEnum	getExtraordinaryDividendsParty()	Specifies the party which determines if dividends are extraordinary in relation to normal levels.
DividendPeriodEnum	getFirstOrSecondPeriod()	2002 ISDA Equity Derivatives Definitions: Dividend Period as either the First Period or the Second Period
Boolean	getMaterialDividend()	If present and true, then material non cash dividends are applicable.
NonCashDividendTreatmentEnum	getNonCashDividendTreatment()	Specifies the treatment of Non-Cash Dividends.
DividendCurrency.DividendCurrencyBuilder	getOrCreateDividendCurrency()
DividendPayoutRatio.DividendPayoutRatioBuilder	getOrCreateDividendPayoutRatio(int index)
DividendPeriod.DividendPeriodBuilder	getOrCreateDividendPeriod(int index)
String	getPerformance()	Performance calculation, in accordance with Part 1 Section 12 of the 2018 ISDA CDM Equity Confirmation for Security Equity Swap, Para 75.
Boolean	getSpecialDividends()	Specifies the method according to which special dividends are determined.
boolean	hasData()
int	hashCode()
DividendReturnTerms.DividendReturnTermsBuilder	merge(com.rosetta.model.lib.RosettaModelObjectBuilder other, com.rosetta.model.lib.process.BuilderMerger merger)
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> dividendPayoutRatios)
DividendReturnTerms.DividendReturnTermsBuilder	setDividendPeriod(List<? extends DividendPeriod> dividendPeriods)
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)
DividendReturnTerms.DividendReturnTermsBuilder	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface cdm.product.asset.DividendReturnTerms

getType, metaData, process

Methods inherited from interface cdm.product.asset.DividendReturnTerms.DividendReturnTermsBuilder

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

dividendPayoutRatio

protected List<DividendPayoutRatio.DividendPayoutRatioBuilder> dividendPayoutRatio

dividendReinvestment

protected Boolean dividendReinvestment

dividendEntitlement

protected DividendEntitlementEnum dividendEntitlement

dividendAmountType

protected DividendAmountTypeEnum dividendAmountType

performance

protected String performance

firstOrSecondPeriod

protected DividendPeriodEnum firstOrSecondPeriod

extraordinaryDividendsParty

protected AncillaryRoleEnum extraordinaryDividendsParty

excessDividendAmount

protected DividendAmountTypeEnum excessDividendAmount

dividendCurrency

protected DividendCurrency.DividendCurrencyBuilder dividendCurrency

nonCashDividendTreatment

protected NonCashDividendTreatmentEnum nonCashDividendTreatment

dividendComposition

protected DividendCompositionEnum dividendComposition

specialDividends

protected Boolean specialDividends

materialDividend

protected Boolean materialDividend

dividendPeriod

protected List<DividendPeriod.DividendPeriodBuilder> dividendPeriod

Constructor Details

DividendReturnTermsBuilderImpl

public DividendReturnTermsBuilderImpl()

Method Details

getDividendPayoutRatio

@RosettaAttribute("dividendPayoutRatio")
@RuneAttribute("dividendPayoutRatio")
public 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

Specified by:

getDividendPayoutRatio in interface DividendReturnTerms.DividendReturnTermsBuilder

getOrCreateDividendPayoutRatio

public DividendPayoutRatio.DividendPayoutRatioBuilder getOrCreateDividendPayoutRatio(int index)

Specified by:

getOrCreateDividendPayoutRatio in interface DividendReturnTerms.DividendReturnTermsBuilder

getDividendReinvestment

@RosettaAttribute("dividendReinvestment")
@RuneAttribute("dividendReinvestment")
public Boolean getDividendReinvestment()

Description copied from interface: DividendReturnTerms

Boolean element that defines whether the dividend will be reinvested or not.

Specified by:

getDividendReinvestment in interface DividendReturnTerms

getDividendEntitlement

@RosettaAttribute("dividendEntitlement")
@RuneAttribute("dividendEntitlement")
public DividendEntitlementEnum getDividendEntitlement()

Description copied from interface: DividendReturnTerms

Defines the date on which the receiver of the equity return is entitled to the dividend.

Specified by:

getDividendEntitlement in interface DividendReturnTerms

getDividendAmountType

@RosettaAttribute("dividendAmountType")
@RuneAttribute("dividendAmountType")
public DividendAmountTypeEnum getDividendAmountType()

Description copied from interface: DividendReturnTerms

Specifies whether the dividend is paid with respect to the Dividend Period.

Specified by:

getDividendAmountType in interface DividendReturnTerms

getPerformance

@RosettaAttribute("performance")
@RuneAttribute("performance")
public String getPerformance()

Description copied from interface: DividendReturnTerms

Performance calculation, in accordance with Part 1 Section 12 of the 2018 ISDA CDM Equity Confirmation for Security Equity Swap, Para 75. 'Equity Performance'. Cumulative performance is used as a notional multiplier factor on both legs of an Equity Swap.

Specified by:

getPerformance in interface DividendReturnTerms

getFirstOrSecondPeriod

@RosettaAttribute("firstOrSecondPeriod")
@RuneAttribute("firstOrSecondPeriod")
public DividendPeriodEnum getFirstOrSecondPeriod()

Description copied from interface: DividendReturnTerms

2002 ISDA Equity Derivatives Definitions: Dividend Period as either the First Period or the Second Period. |

Specified by:

getFirstOrSecondPeriod in interface DividendReturnTerms

getExtraordinaryDividendsParty

@RosettaAttribute("extraordinaryDividendsParty")
@RuneAttribute("extraordinaryDividendsParty")
public AncillaryRoleEnum getExtraordinaryDividendsParty()

Description copied from interface: DividendReturnTerms

Specifies the party which determines if dividends are extraordinary in relation to normal levels.

Specified by:

getExtraordinaryDividendsParty in interface DividendReturnTerms

getExcessDividendAmount

@RosettaAttribute("excessDividendAmount")
@RuneAttribute("excessDividendAmount")
public DividendAmountTypeEnum getExcessDividendAmount()

Description copied from interface: DividendReturnTerms

Determination of Gross Cash Dividend per Share.

Specified by:

getExcessDividendAmount in interface DividendReturnTerms

getDividendCurrency

@RosettaAttribute("dividendCurrency")
@RuneAttribute("dividendCurrency")
public 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

Specified by:

getDividendCurrency in interface DividendReturnTerms.DividendReturnTermsBuilder

getOrCreateDividendCurrency

public DividendCurrency.DividendCurrencyBuilder getOrCreateDividendCurrency()

Specified by:

getOrCreateDividendCurrency in interface DividendReturnTerms.DividendReturnTermsBuilder

getNonCashDividendTreatment

@RosettaAttribute("nonCashDividendTreatment")
@RuneAttribute("nonCashDividendTreatment")
public NonCashDividendTreatmentEnum getNonCashDividendTreatment()

Description copied from interface: DividendReturnTerms

Specifies the treatment of Non-Cash Dividends.

Specified by:

getNonCashDividendTreatment in interface DividendReturnTerms

getDividendComposition

@RosettaAttribute("dividendComposition")
@RuneAttribute("dividendComposition")
public DividendCompositionEnum getDividendComposition()

Description copied from interface: DividendReturnTerms

Specifies how the composition of Dividends is to be determined.

Specified by:

getDividendComposition in interface DividendReturnTerms

getSpecialDividends

@RosettaAttribute("specialDividends")
@RuneAttribute("specialDividends")
public Boolean getSpecialDividends()

Description copied from interface: DividendReturnTerms

Specifies the method according to which special dividends are determined.

Specified by:

getSpecialDividends in interface DividendReturnTerms

getMaterialDividend

@RosettaAttribute("materialDividend")
@RuneAttribute("materialDividend")
public Boolean getMaterialDividend()

Description copied from interface: DividendReturnTerms

If present and true, then material non cash dividends are applicable.

Specified by:

getMaterialDividend in interface DividendReturnTerms

getDividendPeriod

@RosettaAttribute("dividendPeriod")
@RuneAttribute("dividendPeriod")
public 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

Specified by:

getDividendPeriod in interface DividendReturnTerms.DividendReturnTermsBuilder

getOrCreateDividendPeriod

public DividendPeriod.DividendPeriodBuilder getOrCreateDividendPeriod(int index)

Specified by:

getOrCreateDividendPeriod in interface DividendReturnTerms.DividendReturnTermsBuilder

addDividendPayoutRatio

@RosettaAttribute("dividendPayoutRatio")
@RuneAttribute("dividendPayoutRatio")
public DividendReturnTerms.DividendReturnTermsBuilder addDividendPayoutRatio(DividendPayoutRatio _dividendPayoutRatio)

Specified by:

addDividendPayoutRatio in interface DividendReturnTerms.DividendReturnTermsBuilder

addDividendPayoutRatio

public DividendReturnTerms.DividendReturnTermsBuilder addDividendPayoutRatio(DividendPayoutRatio _dividendPayoutRatio,
 int idx)

Specified by:

addDividendPayoutRatio in interface DividendReturnTerms.DividendReturnTermsBuilder

addDividendPayoutRatio

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

Specified by:

addDividendPayoutRatio in interface DividendReturnTerms.DividendReturnTermsBuilder

setDividendPayoutRatio

@RuneAttribute("dividendPayoutRatio")
public DividendReturnTerms.DividendReturnTermsBuilder setDividendPayoutRatio(List<? extends DividendPayoutRatio> dividendPayoutRatios)

Specified by:

setDividendPayoutRatio in interface DividendReturnTerms.DividendReturnTermsBuilder

setDividendReinvestment

@RosettaAttribute("dividendReinvestment")
@RuneAttribute("dividendReinvestment")
public DividendReturnTerms.DividendReturnTermsBuilder setDividendReinvestment(Boolean _dividendReinvestment)

Specified by:

setDividendReinvestment in interface DividendReturnTerms.DividendReturnTermsBuilder

setDividendEntitlement

@RosettaAttribute("dividendEntitlement")
@RuneAttribute("dividendEntitlement")
public DividendReturnTerms.DividendReturnTermsBuilder setDividendEntitlement(DividendEntitlementEnum _dividendEntitlement)

Specified by:

setDividendEntitlement in interface DividendReturnTerms.DividendReturnTermsBuilder

setDividendAmountType

@RosettaAttribute("dividendAmountType")
@RuneAttribute("dividendAmountType")
public DividendReturnTerms.DividendReturnTermsBuilder setDividendAmountType(DividendAmountTypeEnum _dividendAmountType)

Specified by:

setDividendAmountType in interface DividendReturnTerms.DividendReturnTermsBuilder

setPerformance

@RosettaAttribute("performance")
@RuneAttribute("performance")
public DividendReturnTerms.DividendReturnTermsBuilder setPerformance(String _performance)

Specified by:

setPerformance in interface DividendReturnTerms.DividendReturnTermsBuilder

setFirstOrSecondPeriod

@RosettaAttribute("firstOrSecondPeriod")
@RuneAttribute("firstOrSecondPeriod")
public DividendReturnTerms.DividendReturnTermsBuilder setFirstOrSecondPeriod(DividendPeriodEnum _firstOrSecondPeriod)

Specified by:

setFirstOrSecondPeriod in interface DividendReturnTerms.DividendReturnTermsBuilder

setExtraordinaryDividendsParty

@RosettaAttribute("extraordinaryDividendsParty")
@RuneAttribute("extraordinaryDividendsParty")
public DividendReturnTerms.DividendReturnTermsBuilder setExtraordinaryDividendsParty(AncillaryRoleEnum _extraordinaryDividendsParty)

Specified by:

setExtraordinaryDividendsParty in interface DividendReturnTerms.DividendReturnTermsBuilder

setExcessDividendAmount

@RosettaAttribute("excessDividendAmount")
@RuneAttribute("excessDividendAmount")
public DividendReturnTerms.DividendReturnTermsBuilder setExcessDividendAmount(DividendAmountTypeEnum _excessDividendAmount)

Specified by:

setExcessDividendAmount in interface DividendReturnTerms.DividendReturnTermsBuilder

setDividendCurrency

@RosettaAttribute("dividendCurrency")
@RuneAttribute("dividendCurrency")
public DividendReturnTerms.DividendReturnTermsBuilder setDividendCurrency(DividendCurrency _dividendCurrency)

Specified by:

setDividendCurrency in interface DividendReturnTerms.DividendReturnTermsBuilder

setNonCashDividendTreatment

@RosettaAttribute("nonCashDividendTreatment")
@RuneAttribute("nonCashDividendTreatment")
public DividendReturnTerms.DividendReturnTermsBuilder setNonCashDividendTreatment(NonCashDividendTreatmentEnum _nonCashDividendTreatment)

Specified by:

setNonCashDividendTreatment in interface DividendReturnTerms.DividendReturnTermsBuilder

setDividendComposition

@RosettaAttribute("dividendComposition")
@RuneAttribute("dividendComposition")
public DividendReturnTerms.DividendReturnTermsBuilder setDividendComposition(DividendCompositionEnum _dividendComposition)

Specified by:

setDividendComposition in interface DividendReturnTerms.DividendReturnTermsBuilder

setSpecialDividends

@RosettaAttribute("specialDividends")
@RuneAttribute("specialDividends")
public DividendReturnTerms.DividendReturnTermsBuilder setSpecialDividends(Boolean _specialDividends)

Specified by:

setSpecialDividends in interface DividendReturnTerms.DividendReturnTermsBuilder

setMaterialDividend

@RosettaAttribute("materialDividend")
@RuneAttribute("materialDividend")
public DividendReturnTerms.DividendReturnTermsBuilder setMaterialDividend(Boolean _materialDividend)

Specified by:

setMaterialDividend in interface DividendReturnTerms.DividendReturnTermsBuilder

addDividendPeriod

@RosettaAttribute("dividendPeriod")
@RuneAttribute("dividendPeriod")
public DividendReturnTerms.DividendReturnTermsBuilder addDividendPeriod(DividendPeriod _dividendPeriod)

Specified by:

addDividendPeriod in interface DividendReturnTerms.DividendReturnTermsBuilder

addDividendPeriod

public DividendReturnTerms.DividendReturnTermsBuilder addDividendPeriod(DividendPeriod _dividendPeriod,
 int idx)

Specified by:

addDividendPeriod in interface DividendReturnTerms.DividendReturnTermsBuilder

addDividendPeriod

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

Specified by:

addDividendPeriod in interface DividendReturnTerms.DividendReturnTermsBuilder

setDividendPeriod

@RuneAttribute("dividendPeriod")
public DividendReturnTerms.DividendReturnTermsBuilder setDividendPeriod(List<? extends DividendPeriod> dividendPeriods)

Specified by:

setDividendPeriod in interface DividendReturnTerms.DividendReturnTermsBuilder

build

public DividendReturnTerms build()

Description copied from interface: DividendReturnTerms

Build Methods

Specified by:

build in interface DividendReturnTerms

Specified by:

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

toBuilder

public DividendReturnTerms.DividendReturnTermsBuilder toBuilder()

Specified by:

toBuilder in interface DividendReturnTerms

Specified by:

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

prune

public DividendReturnTerms.DividendReturnTermsBuilder prune()

Specified by:

prune in interface DividendReturnTerms.DividendReturnTermsBuilder

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 DividendReturnTerms.DividendReturnTermsBuilder 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