Package org.isda.cdm
Class DividendPayout
- java.lang.Object
-
- com.rosetta.model.lib.RosettaModelObject
-
- org.isda.cdm.DividendPayout
-
@RosettaClass @RosettaSynonym(value="DividendPayout", source="FpML_5_10") public class DividendPayout extends com.rosetta.model.lib.RosettaModelObject
A class describing the dividend payout ratio associated with an equity underlier. In certain cases the actual ratio is not known on trade inception, and only general conditions are then specified.- Version:
- 2.5.4
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
DividendPayout.DividendPayoutBuilder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static DividendPayout.DividendPayoutBuilder
builder()
boolean
equals(java.lang.Object o)
java.math.BigDecimal
getDividendPayoutRatio()
Specifies the total actual dividend payout ratio associated with the equity underlier.java.math.BigDecimal
getDividendPayoutRatioCash()
Specifies the cash actual dividend payout ratio associated with the equity underlier.java.math.BigDecimal
getDividendPayoutRatioNonCash()
Specifies the non cash actual dividend payout ratio associated with the equity underlier.int
hashCode()
com.rosetta.model.lib.meta.RosettaMetaData<? extends DividendPayout>
metaData()
void
process(com.rosetta.model.lib.path.RosettaPath path, com.rosetta.model.lib.process.Processor processor)
DividendPayout.DividendPayoutBuilder
toBuilder()
java.lang.String
toString()
-
-
-
Method Detail
-
getDividendPayoutRatio
@RosettaSynonym(value="dividendPayoutRatio", source="FpML_5_10") public final java.math.BigDecimal getDividendPayoutRatio()
Specifies the total actual dividend payout ratio associated with the equity underlier. A ratio of 90% should be expressed at 0.90.
-
getDividendPayoutRatioCash
@RosettaSynonym(value="dividendPayoutRatioCash", source="FpML_5_10") public final java.math.BigDecimal getDividendPayoutRatioCash()
Specifies the cash actual dividend payout ratio associated with the equity underlier. A ratio of 90% should be expressed at 0.90.
-
getDividendPayoutRatioNonCash
@RosettaSynonym(value="dividendPayoutRatioNonCash", source="FpML_5_10") public final java.math.BigDecimal getDividendPayoutRatioNonCash()
Specifies the non cash actual dividend payout ratio associated with the equity underlier. A ratio of 90% should be expressed at 0.90.
-
metaData
public com.rosetta.model.lib.meta.RosettaMetaData<? extends DividendPayout> metaData()
- Specified by:
metaData
in classcom.rosetta.model.lib.RosettaModelObject
-
toBuilder
public DividendPayout.DividendPayoutBuilder toBuilder()
- Specified by:
toBuilder
in classcom.rosetta.model.lib.RosettaModelObject
-
builder
public static DividendPayout.DividendPayoutBuilder builder()
-
process
public void process(com.rosetta.model.lib.path.RosettaPath path, com.rosetta.model.lib.process.Processor processor)
- Specified by:
process
in classcom.rosetta.model.lib.RosettaModelObject
-
equals
public boolean equals(java.lang.Object o)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-