Package cdm.product.asset

Class DividendReturnTerms.DividendReturnTermsImpl

java.lang.Object
cdm.product.asset.DividendReturnTerms.DividendReturnTermsImpl
All Implemented Interfaces:
DividendReturnTerms, com.rosetta.model.lib.RosettaModelObject
Enclosing interface:
DividendReturnTerms
public static class DividendReturnTerms.DividendReturnTermsImpl extends Object implements DividendReturnTerms
Immutable Implementation of DividendReturnTerms

  • Constructor Details

  • Method Details

    • getDividendPayoutRatio

      @RosettaAttribute("dividendPayoutRatio") @Accessor(GETTER) @Multi @RuneAttribute("dividendPayoutRatio") public List<? extends DividendPayoutRatio> getDividendPayoutRatio()
      Description copied from interface: DividendReturnTerms
      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.
      Specified by:
      getDividendPayoutRatio in interface DividendReturnTerms

    • getDividendReinvestment

      @RosettaAttribute("dividendReinvestment") @Accessor(GETTER) @RuneAttribute("dividendReinvestment") public Boolean getDividendReinvestment()
      Description copied from interface: DividendReturnTerms
      Boolean element that defines whether the dividend will be reinvested or not.
      Specified by:
      getDividendReinvestment in interface DividendReturnTerms

    • getDividendEntitlement

      @RosettaAttribute("dividendEntitlement") @Accessor(GETTER) @RuneAttribute("dividendEntitlement") public DividendEntitlementEnum getDividendEntitlement()
      Description copied from interface: DividendReturnTerms
      Defines the date on which the receiver of the equity return is entitled to the dividend.
      Specified by:
      getDividendEntitlement in interface DividendReturnTerms

    • getDividendAmountType

      @RosettaAttribute("dividendAmountType") @Accessor(GETTER) @RuneAttribute("dividendAmountType") public DividendAmountTypeEnum getDividendAmountType()
      Description copied from interface: DividendReturnTerms
      Specifies whether the dividend is paid with respect to the Dividend Period.
      Specified by:
      getDividendAmountType in interface DividendReturnTerms

    • getPerformance

      @RosettaAttribute("performance") @Accessor(GETTER) @RuneAttribute("performance") public String getPerformance()
      Description copied from interface: DividendReturnTerms
      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.
      Specified by:
      getPerformance in interface DividendReturnTerms

    • getFirstOrSecondPeriod

      @RosettaAttribute("firstOrSecondPeriod") @Accessor(GETTER) @RuneAttribute("firstOrSecondPeriod") public DividendPeriodEnum getFirstOrSecondPeriod()
      Description copied from interface: DividendReturnTerms
      2002 ISDA Equity Derivatives Definitions: Dividend Period as either the First Period or the Second Period. |
      Specified by:
      getFirstOrSecondPeriod in interface DividendReturnTerms

    • getExtraordinaryDividendsParty

      @RosettaAttribute("extraordinaryDividendsParty") @Accessor(GETTER) @RuneAttribute("extraordinaryDividendsParty") public AncillaryRoleEnum getExtraordinaryDividendsParty()
      Description copied from interface: DividendReturnTerms
      Specifies the party which determines if dividends are extraordinary in relation to normal levels.
      Specified by:
      getExtraordinaryDividendsParty in interface DividendReturnTerms

    • getExcessDividendAmount

      @RosettaAttribute("excessDividendAmount") @Accessor(GETTER) @RuneAttribute("excessDividendAmount") public DividendAmountTypeEnum getExcessDividendAmount()
      Description copied from interface: DividendReturnTerms
      Determination of Gross Cash Dividend per Share.
      Specified by:
      getExcessDividendAmount in interface DividendReturnTerms

    • getDividendCurrency

      @RosettaAttribute("dividendCurrency") @Accessor(GETTER) @RuneAttribute("dividendCurrency") public DividendCurrency getDividendCurrency()
      Description copied from interface: DividendReturnTerms
      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.
      Specified by:
      getDividendCurrency in interface DividendReturnTerms

    • getNonCashDividendTreatment

      @RosettaAttribute("nonCashDividendTreatment") @Accessor(GETTER) @RuneAttribute("nonCashDividendTreatment") public NonCashDividendTreatmentEnum getNonCashDividendTreatment()
      Description copied from interface: DividendReturnTerms
      Specifies the treatment of Non-Cash Dividends.
      Specified by:
      getNonCashDividendTreatment in interface DividendReturnTerms

    • getDividendComposition

      @RosettaAttribute("dividendComposition") @Accessor(GETTER) @RuneAttribute("dividendComposition") public DividendCompositionEnum getDividendComposition()
      Description copied from interface: DividendReturnTerms
      Specifies how the composition of Dividends is to be determined.
      Specified by:
      getDividendComposition in interface DividendReturnTerms

    • getSpecialDividends

      @RosettaAttribute("specialDividends") @Accessor(GETTER) @RuneAttribute("specialDividends") public Boolean getSpecialDividends()
      Description copied from interface: DividendReturnTerms
      Specifies the method according to which special dividends are determined.
      Specified by:
      getSpecialDividends in interface DividendReturnTerms

    • getMaterialDividend

      @RosettaAttribute("materialDividend") @Accessor(GETTER) @RuneAttribute("materialDividend") public Boolean getMaterialDividend()
      Description copied from interface: DividendReturnTerms
      If present and true, then material non cash dividends are applicable.
      Specified by:
      getMaterialDividend in interface DividendReturnTerms

    • getDividendPeriod

      @RosettaAttribute("dividendPeriod") @Accessor(GETTER) @Multi @RuneAttribute("dividendPeriod") public List<? extends DividendPeriod> getDividendPeriod()
      Description copied from interface: DividendReturnTerms
      One to many time bounded dividend payment periods, each with a dividend payment date per period.
      Specified by:
      getDividendPeriod in interface DividendReturnTerms

    • build

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

    • toBuilder

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

    • setBuilderFields

      protected void setBuilderFields(DividendReturnTerms.DividendReturnTermsBuilder 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