Package cdm.product.asset

Class DividendReturnTerms.DividendReturnTermsImpl

java.lang.Object

cdm.product.asset.DividendReturnTerms.DividendReturnTermsImpl

All Implemented Interfaces:

DividendReturnTerms, com.rosetta.model.lib.RosettaModelObject

Enclosing interface:

DividendReturnTerms

public static class DividendReturnTerms.DividendReturnTermsImpl
extends Object
implements DividendReturnTerms

Immutable 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 inherited from interface cdm.product.asset.DividendReturnTerms

metaData

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DividendReturnTermsImpl(DividendReturnTerms.DividendReturnTermsBuilder builder)

Method Summary

Modifier and Type	Method	Description
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	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>	getDividendPayoutRatio()	Specifies the dividend payout ratio associated with each underlier.
List<? extends DividendPeriod>	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.
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.
int	hashCode()
protected void	setBuilderFields(DividendReturnTerms.DividendReturnTermsBuilder builder)
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 com.rosetta.model.lib.RosettaModelObject

processRosetta, processRosetta

Constructor Details

DividendReturnTermsImpl

protected DividendReturnTermsImpl(DividendReturnTerms.DividendReturnTermsBuilder builder)

Method Details

getDividendPayoutRatio

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

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

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

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

setBuilderFields

protected void setBuilderFields(DividendReturnTerms.DividendReturnTermsBuilder 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