Package cdm.product.asset

Interface DividendReturnTerms

All Superinterfaces:
com.rosetta.model.lib.RosettaModelObject
All Known Subinterfaces:
DividendReturnTerms.DividendReturnTermsBuilder
All Known Implementing Classes:
DividendReturnTerms.DividendReturnTermsBuilderImpl, DividendReturnTerms.DividendReturnTermsImpl
@RosettaDataType(value="DividendReturnTerms", builder=DividendReturnTermsBuilderImpl.class, version="5.30.0") @RuneDataType(value="DividendReturnTerms", model="cdm", builder=DividendReturnTermsBuilderImpl.class, version="5.30.0") public interface 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:
5.30.0

  • Field Details

  • Method Details

    • getDividendPayoutRatio

      List<? extends DividendPayoutRatio> getDividendPayoutRatio()
      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.

    • getDividendReinvestment

      Boolean getDividendReinvestment()
      Boolean element that defines whether the dividend will be reinvested or not.

    • getDividendEntitlement

      DividendEntitlementEnum getDividendEntitlement()
      Defines the date on which the receiver of the equity return is entitled to the dividend.

    • getDividendAmountType

      DividendAmountTypeEnum getDividendAmountType()
      Specifies whether the dividend is paid with respect to the Dividend Period.

    • getPerformance

      String getPerformance()
      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.

    • getFirstOrSecondPeriod

      DividendPeriodEnum getFirstOrSecondPeriod()
      2002 ISDA Equity Derivatives Definitions: Dividend Period as either the First Period or the Second Period. |

    • getExtraordinaryDividendsParty

      AncillaryRoleEnum getExtraordinaryDividendsParty()
      Specifies the party which determines if dividends are extraordinary in relation to normal levels.

    • getExcessDividendAmount

      DividendAmountTypeEnum getExcessDividendAmount()
      Determination of Gross Cash Dividend per Share.

    • getDividendCurrency

      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.

    • getNonCashDividendTreatment

      NonCashDividendTreatmentEnum getNonCashDividendTreatment()
      Specifies the treatment of Non-Cash Dividends.

    • getDividendComposition

      DividendCompositionEnum getDividendComposition()
      Specifies how the composition of Dividends is to be determined.

    • getSpecialDividends

      Boolean getSpecialDividends()
      Specifies the method according to which special dividends are determined.

    • getMaterialDividend

      Boolean getMaterialDividend()
      If present and true, then material non cash dividends are applicable.

    • getDividendPeriod

      List<? extends DividendPeriod> getDividendPeriod()
      One to many time bounded dividend payment periods, each with a dividend payment date per period.

    • build

      DividendReturnTerms build()
      Build Methods
      Specified by:
      build in interface com.rosetta.model.lib.RosettaModelObject

    • toBuilder

      DividendReturnTerms.DividendReturnTermsBuilder toBuilder()
      Specified by:
      toBuilder in interface com.rosetta.model.lib.RosettaModelObject

    • builder

      static DividendReturnTerms.DividendReturnTermsBuilder builder()

    • metaData

      default com.rosetta.model.lib.meta.RosettaMetaData<? extends DividendReturnTerms> metaData()
      Utility Methods
      Specified by:
      metaData in interface com.rosetta.model.lib.RosettaModelObject

    • getType

      @RuneAttribute("@type") default Class<? extends DividendReturnTerms> getType()
      Specified by:
      getType in interface com.rosetta.model.lib.RosettaModelObject

    • process

      default void process(com.rosetta.model.lib.path.RosettaPath path, com.rosetta.model.lib.process.Processor processor)
      Specified by:
      process in interface com.rosetta.model.lib.RosettaModelObject