Package cdm.product.asset

Class DividendPayoutRatio.DividendPayoutRatioBuilderImpl

java.lang.Object

cdm.product.asset.DividendPayoutRatio.DividendPayoutRatioBuilderImpl

All Implemented Interfaces:

DividendPayoutRatio, DividendPayoutRatio.DividendPayoutRatioBuilder, com.rosetta.model.lib.RosettaModelObject, com.rosetta.model.lib.RosettaModelObjectBuilder

Enclosing interface:

DividendPayoutRatio

public static class DividendPayoutRatio.DividendPayoutRatioBuilderImpl
extends Object
implements DividendPayoutRatio.DividendPayoutRatioBuilder

Builder 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

Modifier and Type	Field	Description
protected Product.ProductBuilder	basketConstituent
protected BigDecimal	cashRatio
protected BigDecimal	nonCashRatio
protected BigDecimal	totalRatio

Fields inherited from interface cdm.product.asset.DividendPayoutRatio

metaData

Constructor Summary

Constructors

Constructor	Description
DividendPayoutRatioBuilderImpl()

Method Summary

Modifier and Type	Method	Description
DividendPayoutRatio	build()	Build Methods
boolean	equals(Object o)
Product.ProductBuilder	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.
Product.ProductBuilder	getOrCreateBasketConstituent()
BigDecimal	getTotalRatio()	Specifies the total actual dividend payout ratio associated with the equity underlier.
boolean	hasData()
int	hashCode()
DividendPayoutRatio.DividendPayoutRatioBuilder	merge(com.rosetta.model.lib.RosettaModelObjectBuilder other, com.rosetta.model.lib.process.BuilderMerger merger)
DividendPayoutRatio.DividendPayoutRatioBuilder	prune()
DividendPayoutRatio.DividendPayoutRatioBuilder	setBasketConstituent(Product _basketConstituent)
DividendPayoutRatio.DividendPayoutRatioBuilder	setCashRatio(BigDecimal _cashRatio)
DividendPayoutRatio.DividendPayoutRatioBuilder	setNonCashRatio(BigDecimal _nonCashRatio)
DividendPayoutRatio.DividendPayoutRatioBuilder	setTotalRatio(BigDecimal _totalRatio)
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 cdm.product.asset.DividendPayoutRatio.DividendPayoutRatioBuilder

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

totalRatio

protected BigDecimal totalRatio

cashRatio

protected BigDecimal cashRatio

nonCashRatio

protected BigDecimal nonCashRatio

basketConstituent

protected Product.ProductBuilder basketConstituent

Constructor Details

DividendPayoutRatioBuilderImpl

public DividendPayoutRatioBuilderImpl()

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

Specified by:

getBasketConstituent in interface DividendPayoutRatio.DividendPayoutRatioBuilder

getOrCreateBasketConstituent

public Product.ProductBuilder getOrCreateBasketConstituent()

Specified by:

getOrCreateBasketConstituent in interface DividendPayoutRatio.DividendPayoutRatioBuilder

setTotalRatio

@RosettaAttribute(value="totalRatio",
                  isRequired=true)
@RuneAttribute(value="totalRatio",
               isRequired=true)
public DividendPayoutRatio.DividendPayoutRatioBuilder setTotalRatio(BigDecimal _totalRatio)

Specified by:

setTotalRatio in interface DividendPayoutRatio.DividendPayoutRatioBuilder

setCashRatio

@RosettaAttribute("cashRatio")
@RuneAttribute("cashRatio")
public DividendPayoutRatio.DividendPayoutRatioBuilder setCashRatio(BigDecimal _cashRatio)

Specified by:

setCashRatio in interface DividendPayoutRatio.DividendPayoutRatioBuilder

setNonCashRatio

@RosettaAttribute("nonCashRatio")
@RuneAttribute("nonCashRatio")
public DividendPayoutRatio.DividendPayoutRatioBuilder setNonCashRatio(BigDecimal _nonCashRatio)

Specified by:

setNonCashRatio in interface DividendPayoutRatio.DividendPayoutRatioBuilder

setBasketConstituent

@RosettaAttribute("basketConstituent")
@RuneAttribute("basketConstituent")
public DividendPayoutRatio.DividendPayoutRatioBuilder setBasketConstituent(Product _basketConstituent)

Specified by:

setBasketConstituent in interface DividendPayoutRatio.DividendPayoutRatioBuilder

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

prune

public DividendPayoutRatio.DividendPayoutRatioBuilder prune()

Specified by:

prune in interface DividendPayoutRatio.DividendPayoutRatioBuilder

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 DividendPayoutRatio.DividendPayoutRatioBuilder 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