Package net.finmath.smartcontract.product.xml

Class DividendConditions

java.lang.Object
net.finmath.smartcontract.product.xml.DividendConditions
public class DividendConditions extends Object
A type 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.

Java class for DividendConditions complex type.

The following schema fragment specifies the expected content contained within this class. 

 <complexType name="DividendConditions">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="dividendReinvestment" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="dividendEntitlement" type="{http://www.fpml.org/FpML-5/confirmation}DividendEntitlementEnum" minOccurs="0"/>
         <element name="dividendAmount" type="{http://www.fpml.org/FpML-5/confirmation}DividendAmountTypeEnum" minOccurs="0"/>
         <element name="dividendPaymentDate" type="{http://www.fpml.org/FpML-5/confirmation}DividendPaymentDate" minOccurs="0"/>
         <choice>
           <sequence>
             <element name="dividendPeriodEffectiveDate" type="{http://www.fpml.org/FpML-5/confirmation}DateReference" minOccurs="0"/>
             <element name="dividendPeriodEndDate" type="{http://www.fpml.org/FpML-5/confirmation}DateReference" minOccurs="0"/>
           </sequence>
           <element name="dividendPeriod" type="{http://www.fpml.org/FpML-5/confirmation}DividendPeriodEnum"/>
         </choice>
         <element name="extraOrdinaryDividends" type="{http://www.fpml.org/FpML-5/confirmation}PartyReference" minOccurs="0"/>
         <element name="excessDividendAmount" type="{http://www.fpml.org/FpML-5/confirmation}DividendAmountTypeEnum" minOccurs="0"/>
         <group ref="{http://www.fpml.org/FpML-5/confirmation}CurrencyAndDeterminationMethod.model" minOccurs="0"/>
         <element name="dividendFxTriggerDate" type="{http://www.fpml.org/FpML-5/confirmation}DividendPaymentDate" minOccurs="0"/>
         <element name="interestAccrualsMethod" type="{http://www.fpml.org/FpML-5/confirmation}InterestAccrualsCompoundingMethod" minOccurs="0"/>
         <element name="numberOfIndexUnits" type="{http://www.fpml.org/FpML-5/confirmation}NonNegativeDecimal" minOccurs="0"/>
         <group ref="{http://www.fpml.org/FpML-5/confirmation}DeclaredCashAndCashEquivalentDividendPercentage.model"/>
         <element name="nonCashDividendTreatment" type="{http://www.fpml.org/FpML-5/confirmation}NonCashDividendTreatmentEnum" minOccurs="0"/>
         <element name="dividendComposition" type="{http://www.fpml.org/FpML-5/confirmation}DividendCompositionEnum" minOccurs="0"/>
         <element name="specialDividends" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>

  • Field Details

  • Constructor Details

    • DividendConditions

      public DividendConditions()

  • Method Details

    • isDividendReinvestment

      public Boolean isDividendReinvestment()
      Gets the value of the dividendReinvestment property.
      Returns:
      possible object is Boolean

    • setDividendReinvestment

      public void setDividendReinvestment​(Boolean value)
      Sets the value of the dividendReinvestment property.
      Parameters:
      value - allowed object is Boolean

    • getDividendEntitlement

      public DividendEntitlementEnum getDividendEntitlement()
      Gets the value of the dividendEntitlement property.
      Returns:
      possible object is DividendEntitlementEnum

    • setDividendEntitlement

      public void setDividendEntitlement​(DividendEntitlementEnum value)
      Sets the value of the dividendEntitlement property.
      Parameters:
      value - allowed object is DividendEntitlementEnum

    • getDividendAmount

      public DividendAmountTypeEnum getDividendAmount()
      Gets the value of the dividendAmount property.
      Returns:
      possible object is DividendAmountTypeEnum

    • setDividendAmount

      public void setDividendAmount​(DividendAmountTypeEnum value)
      Sets the value of the dividendAmount property.
      Parameters:
      value - allowed object is DividendAmountTypeEnum

    • getDividendPaymentDate

      public DividendPaymentDate getDividendPaymentDate()
      Gets the value of the dividendPaymentDate property.
      Returns:
      possible object is DividendPaymentDate

    • setDividendPaymentDate

      public void setDividendPaymentDate​(DividendPaymentDate value)
      Sets the value of the dividendPaymentDate property.
      Parameters:
      value - allowed object is DividendPaymentDate

    • getDividendPeriodEffectiveDate

      public DateReference getDividendPeriodEffectiveDate()
      Gets the value of the dividendPeriodEffectiveDate property.
      Returns:
      possible object is DateReference

    • setDividendPeriodEffectiveDate

      public void setDividendPeriodEffectiveDate​(DateReference value)
      Sets the value of the dividendPeriodEffectiveDate property.
      Parameters:
      value - allowed object is DateReference

    • getDividendPeriodEndDate

      public DateReference getDividendPeriodEndDate()
      Gets the value of the dividendPeriodEndDate property.
      Returns:
      possible object is DateReference

    • setDividendPeriodEndDate

      public void setDividendPeriodEndDate​(DateReference value)
      Sets the value of the dividendPeriodEndDate property.
      Parameters:
      value - allowed object is DateReference

    • getDividendPeriod

      public DividendPeriodEnum getDividendPeriod()
      Gets the value of the dividendPeriod property.
      Returns:
      possible object is DividendPeriodEnum

    • setDividendPeriod

      public void setDividendPeriod​(DividendPeriodEnum value)
      Sets the value of the dividendPeriod property.
      Parameters:
      value - allowed object is DividendPeriodEnum

    • getExtraOrdinaryDividends

      public PartyReference getExtraOrdinaryDividends()
      Gets the value of the extraOrdinaryDividends property.
      Returns:
      possible object is PartyReference

    • setExtraOrdinaryDividends

      public void setExtraOrdinaryDividends​(PartyReference value)
      Sets the value of the extraOrdinaryDividends property.
      Parameters:
      value - allowed object is PartyReference

    • getExcessDividendAmount

      public DividendAmountTypeEnum getExcessDividendAmount()
      Gets the value of the excessDividendAmount property.
      Returns:
      possible object is DividendAmountTypeEnum

    • setExcessDividendAmount

      public void setExcessDividendAmount​(DividendAmountTypeEnum value)
      Sets the value of the excessDividendAmount property.
      Parameters:
      value - allowed object is DividendAmountTypeEnum

    • getCurrency

      public IdentifiedCurrency getCurrency()
      Gets the value of the currency property.
      Returns:
      possible object is IdentifiedCurrency

    • setCurrency

      public void setCurrency​(IdentifiedCurrency value)
      Sets the value of the currency property.
      Parameters:
      value - allowed object is IdentifiedCurrency

    • getDeterminationMethod

      public DeterminationMethod getDeterminationMethod()
      Gets the value of the determinationMethod property.
      Returns:
      possible object is DeterminationMethod

    • setDeterminationMethod

      public void setDeterminationMethod​(DeterminationMethod value)
      Sets the value of the determinationMethod property.
      Parameters:
      value - allowed object is DeterminationMethod

    • getCurrencyReference

      public IdentifiedCurrencyReference getCurrencyReference()
      Gets the value of the currencyReference property.
      Returns:
      possible object is IdentifiedCurrencyReference

    • setCurrencyReference

      public void setCurrencyReference​(IdentifiedCurrencyReference value)
      Sets the value of the currencyReference property.
      Parameters:
      value - allowed object is IdentifiedCurrencyReference

    • getDividendFxTriggerDate

      public DividendPaymentDate getDividendFxTriggerDate()
      Gets the value of the dividendFxTriggerDate property.
      Returns:
      possible object is DividendPaymentDate

    • setDividendFxTriggerDate

      public void setDividendFxTriggerDate​(DividendPaymentDate value)
      Sets the value of the dividendFxTriggerDate property.
      Parameters:
      value - allowed object is DividendPaymentDate

    • getInterestAccrualsMethod

      public InterestAccrualsCompoundingMethod getInterestAccrualsMethod()
      Gets the value of the interestAccrualsMethod property.
      Returns:
      possible object is InterestAccrualsCompoundingMethod

    • setInterestAccrualsMethod

      public void setInterestAccrualsMethod​(InterestAccrualsCompoundingMethod value)
      Sets the value of the interestAccrualsMethod property.
      Parameters:
      value - allowed object is InterestAccrualsCompoundingMethod

    • getNumberOfIndexUnits

      public BigDecimal getNumberOfIndexUnits()
      Gets the value of the numberOfIndexUnits property.
      Returns:
      possible object is BigDecimal

    • setNumberOfIndexUnits

      public void setNumberOfIndexUnits​(BigDecimal value)
      Sets the value of the numberOfIndexUnits property.
      Parameters:
      value - allowed object is BigDecimal

    • getDeclaredCashDividendPercentage

      public BigDecimal getDeclaredCashDividendPercentage()
      Gets the value of the declaredCashDividendPercentage property.
      Returns:
      possible object is BigDecimal

    • setDeclaredCashDividendPercentage

      public void setDeclaredCashDividendPercentage​(BigDecimal value)
      Sets the value of the declaredCashDividendPercentage property.
      Parameters:
      value - allowed object is BigDecimal

    • getDeclaredCashEquivalentDividendPercentage

      public BigDecimal getDeclaredCashEquivalentDividendPercentage()
      Gets the value of the declaredCashEquivalentDividendPercentage property.
      Returns:
      possible object is BigDecimal

    • setDeclaredCashEquivalentDividendPercentage

      public void setDeclaredCashEquivalentDividendPercentage​(BigDecimal value)
      Sets the value of the declaredCashEquivalentDividendPercentage property.
      Parameters:
      value - allowed object is BigDecimal

    • getNonCashDividendTreatment

      public NonCashDividendTreatmentEnum getNonCashDividendTreatment()
      Gets the value of the nonCashDividendTreatment property.
      Returns:
      possible object is NonCashDividendTreatmentEnum

    • setNonCashDividendTreatment

      public void setNonCashDividendTreatment​(NonCashDividendTreatmentEnum value)
      Sets the value of the nonCashDividendTreatment property.
      Parameters:
      value - allowed object is NonCashDividendTreatmentEnum

    • getDividendComposition

      public DividendCompositionEnum getDividendComposition()
      Gets the value of the dividendComposition property.
      Returns:
      possible object is DividendCompositionEnum

    • setDividendComposition

      public void setDividendComposition​(DividendCompositionEnum value)
      Sets the value of the dividendComposition property.
      Parameters:
      value - allowed object is DividendCompositionEnum

    • isSpecialDividends

      public Boolean isSpecialDividends()
      Gets the value of the specialDividends property.
      Returns:
      possible object is Boolean

    • setSpecialDividends

      public void setSpecialDividends​(Boolean value)
      Sets the value of the specialDividends property.
      Parameters:
      value - allowed object is Boolean