Package cdm.product.asset

Interface DividendPayoutRatio

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

  • Field Details

  • Method Details

    • getTotalRatio

      BigDecimal getTotalRatio()
      Specifies the total actual dividend payout ratio associated with the equity underlier. A ratio of 90% should be expressed at 0.90.

    • getCashRatio

      BigDecimal getCashRatio()
      Specifies the cash actual dividend payout ratio associated with the equity underlier. A ratio of 90% should be expressed at 0.90.

    • getNonCashRatio

      BigDecimal getNonCashRatio()
      Specifies the non cash actual dividend payout ratio associated with the equity underlier. A ratio of 90% should be expressed at 0.90.

    • getBasketConstituent

      Product getBasketConstituent()
      In the case of a basket underlier, specifies to which component of the basket this particular set of dividend payout ratios correspond.

    • build

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

    • toBuilder

      DividendPayoutRatio.DividendPayoutRatioBuilder toBuilder()
      Specified by:
      toBuilder in interface com.rosetta.model.lib.RosettaModelObject

    • builder

      static DividendPayoutRatio.DividendPayoutRatioBuilder builder()

    • metaData

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

    • getType

      @RuneAttribute("@type") default Class<? extends DividendPayoutRatio> 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