Package org.isda.cdm

Class DividendReturnTerms


  • @RosettaClass
    @RosettaSynonym(value="DividendConditions",
                    source="FpML_5_10")
    public class DividendReturnTerms
    extends com.rosetta.model.lib.RosettaModelObject
    A class describing the conditions governing the payment of dividends to the receiver of the equity return, with the exception of the dividend payout ratio, which is defined for each of the underlying components.
    Version:
    2.5.4
    • Method Detail

      • getDividendAmountType

        @RosettaSynonym(value="dividendAmount",
                        source="FpML_5_10")
        public final DividendAmountTypeEnum getDividendAmountType()
        Specifies whether the dividend is paid with respect to the Dividend Period.
      • getDividendCurrency

        public final DividendCurrency getDividendCurrency()
        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.
      • getDividendEntitlement

        @RosettaSynonym(value="dividendEntitlement",
                        source="FpML_5_10")
        public final DividendEntitlementEnum getDividendEntitlement()
        Defines the date on which the receiver of the equity return is entitled to the dividend.
      • getDividendPaymentDate

        @RosettaSynonym(value="dividendPaymentDate",
                        source="FpML_5_10")
        public final DividendPaymentDate getDividendPaymentDate()
        Specifies when the dividend will be paid to the receiver of the equity return. Has the meaning as defined in the ISDA 2002 Equity Derivatives Definitions. Is not applicable in the case of a dividend reinvestment election.
      • getDividendPayout

        @RosettaSynonym(value="dividendPayout",
                        source="FpML_5_10")
        public final DividendPayout getDividendPayout()
        Specifies the dividend payout ratio associated with the 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.
      • getDividendPeriod

        @RosettaSynonym(value="dividendPeriod",
                        source="FpML_5_10")
        public final DividendPeriodEnum getDividendPeriod()
        2002 ISDA Equity Derivatives Definitions: Dividend Period as either the First Period or the Second Period. |
      • getDividendPeriodEffectiveDate

        @RosettaSynonym(value="dividendPeriodEffectiveDate",
                        source="FpML_5_10")
        public final BasicReferenceWithMetaDate getDividendPeriodEffectiveDate()
        2002 ISDA Equity Derivatives Definitions: Dividend Period as such other period determined as provided in the related Confirmation. |
      • getDividendPeriodEndDate

        @RosettaSynonym(value="dividendPeriodEndDate",
                        source="FpML_5_10")
        public final BasicReferenceWithMetaDate getDividendPeriodEndDate()
        2002 ISDA Equity Derivatives Definitions: Dividend Period as such other period determined as provided in the related Confirmation.
      • getDividendReinvestment

        @RosettaSynonym(value="dividendReinvestment",
                        source="FpML_5_10")
        public final java.lang.Boolean getDividendReinvestment()
        Boolean element that defines whether the dividend will be reinvested or not.
      • getExcessDividendAmount

        @RosettaSynonym(value="excessDividendAmount",
                        source="FpML_5_10")
        public final DividendAmountTypeEnum getExcessDividendAmount()
        Determination of Gross Cash Dividend per Share.
      • getExtraordinaryDividendsParty

        @RosettaSynonym(value="extraOrdinaryDividends",
                        source="FpML_5_10")
        public final ReferenceWithMetaParty getExtraordinaryDividendsParty()
        Reference to the party which determines if dividends are extraordinary in relation to normal levels.
      • metaData

        public com.rosetta.model.lib.meta.RosettaMetaData<? extends DividendReturnTerms> metaData()
        Specified by:
        metaData in class com.rosetta.model.lib.RosettaModelObject
      • process

        public void process​(com.rosetta.model.lib.path.RosettaPath path,
                            com.rosetta.model.lib.process.Processor processor)
        Specified by:
        process in class com.rosetta.model.lib.RosettaModelObject
      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object