Package cdm.product.asset

Class DividendPayoutRatio.DividendPayoutRatioImpl

java.lang.Object

cdm.product.asset.DividendPayoutRatio.DividendPayoutRatioImpl

All Implemented Interfaces:

DividendPayoutRatio, com.rosetta.model.lib.RosettaModelObject

Enclosing interface:

DividendPayoutRatio

public static class DividendPayoutRatio.DividendPayoutRatioImpl
extends Object
implements DividendPayoutRatio

Immutable Implementation of DividendPayoutRatio

Nested Class Summary

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

DividendPayoutRatio.DividendPayoutRatioBuilder, DividendPayoutRatio.DividendPayoutRatioBuilderImpl, DividendPayoutRatio.DividendPayoutRatioImpl

Field Summary

Fields inherited from interface cdm.product.asset.DividendPayoutRatio

metaData

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DividendPayoutRatioImpl(DividendPayoutRatio.DividendPayoutRatioBuilder builder)

Method Summary

Modifier and Type	Method	Description
DividendPayoutRatio	build()	Build Methods
boolean	equals(Object o)
Product	getBasketConstituent()	In the case of a basket underlier, specifies to which component of the basket this particular set of dividend payout ratios correspond.
BigDecimal	getCashRatio()	Specifies the cash actual dividend payout ratio associated with the equity underlier.
BigDecimal	getNonCashRatio()	Specifies the non cash actual dividend payout ratio associated with the equity underlier.
BigDecimal	getTotalRatio()	Specifies the total actual dividend payout ratio associated with the equity underlier.
int	hashCode()
protected void	setBuilderFields(DividendPayoutRatio.DividendPayoutRatioBuilder builder)
DividendPayoutRatio.DividendPayoutRatioBuilder	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.DividendPayoutRatio

getType, metaData, process

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

processRosetta, processRosetta

Constructor Details

DividendPayoutRatioImpl

protected DividendPayoutRatioImpl(DividendPayoutRatio.DividendPayoutRatioBuilder builder)

Method Details

getTotalRatio

@RosettaAttribute(value="totalRatio",
                  isRequired=true)
@RuneAttribute(value="totalRatio",
               isRequired=true)
public BigDecimal getTotalRatio()

Description copied from interface: DividendPayoutRatio

Specifies the total actual dividend payout ratio associated with the equity underlier. A ratio of 90% should be expressed at 0.90.

Specified by:

getTotalRatio in interface DividendPayoutRatio

getCashRatio

@RosettaAttribute("cashRatio")
@RuneAttribute("cashRatio")
public BigDecimal getCashRatio()

Description copied from interface: DividendPayoutRatio

Specifies the cash actual dividend payout ratio associated with the equity underlier. A ratio of 90% should be expressed at 0.90.

Specified by:

getCashRatio in interface DividendPayoutRatio

getNonCashRatio

@RosettaAttribute("nonCashRatio")
@RuneAttribute("nonCashRatio")
public BigDecimal getNonCashRatio()

Description copied from interface: DividendPayoutRatio

Specifies the non cash actual dividend payout ratio associated with the equity underlier. A ratio of 90% should be expressed at 0.90.

Specified by:

getNonCashRatio in interface DividendPayoutRatio

getBasketConstituent

@RosettaAttribute("basketConstituent")
@RuneAttribute("basketConstituent")
public Product getBasketConstituent()

Description copied from interface: DividendPayoutRatio

In the case of a basket underlier, specifies to which component of the basket this particular set of dividend payout ratios correspond.

Specified by:

getBasketConstituent in interface DividendPayoutRatio

build

public DividendPayoutRatio build()

Description copied from interface: DividendPayoutRatio

Build Methods

Specified by:

build in interface DividendPayoutRatio

Specified by:

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

toBuilder

public DividendPayoutRatio.DividendPayoutRatioBuilder toBuilder()

Specified by:

toBuilder in interface DividendPayoutRatio

Specified by:

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

setBuilderFields

protected void setBuilderFields(DividendPayoutRatio.DividendPayoutRatioBuilder 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