Class DividendConditions
java.lang.Object
net.finmath.smartcontract.product.xml.DividendConditions
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 Summary
FieldsModifier and TypeFieldDescriptionprotected IdentifiedCurrencyprotected IdentifiedCurrencyReferenceprotected BigDecimalprotected BigDecimalprotected DeterminationMethodprotected DividendAmountTypeEnumprotected DividendCompositionEnumprotected DividendEntitlementEnumprotected DividendPaymentDateprotected DividendPaymentDateprotected DividendPeriodEnumprotected DateReferenceprotected DateReferenceprotected Booleanprotected DividendAmountTypeEnumprotected PartyReferenceprotected InterestAccrualsCompoundingMethodprotected NonCashDividendTreatmentEnumprotected BigDecimalprotected Boolean -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionGets the value of the currency property.Gets the value of the currencyReference property.Gets the value of the declaredCashDividendPercentage property.Gets the value of the declaredCashEquivalentDividendPercentage property.Gets the value of the determinationMethod property.Gets the value of the dividendAmount property.Gets the value of the dividendComposition property.Gets the value of the dividendEntitlement property.Gets the value of the dividendFxTriggerDate property.Gets the value of the dividendPaymentDate property.Gets the value of the dividendPeriod property.Gets the value of the dividendPeriodEffectiveDate property.Gets the value of the dividendPeriodEndDate property.Gets the value of the excessDividendAmount property.Gets the value of the extraOrdinaryDividends property.Gets the value of the interestAccrualsMethod property.Gets the value of the nonCashDividendTreatment property.Gets the value of the numberOfIndexUnits property.Gets the value of the dividendReinvestment property.Gets the value of the specialDividends property.voidsetCurrency(IdentifiedCurrency value) Sets the value of the currency property.voidSets the value of the currencyReference property.voidSets the value of the declaredCashDividendPercentage property.voidSets the value of the declaredCashEquivalentDividendPercentage property.voidSets the value of the determinationMethod property.voidSets the value of the dividendAmount property.voidSets the value of the dividendComposition property.voidSets the value of the dividendEntitlement property.voidSets the value of the dividendFxTriggerDate property.voidSets the value of the dividendPaymentDate property.voidSets the value of the dividendPeriod property.voidSets the value of the dividendPeriodEffectiveDate property.voidSets the value of the dividendPeriodEndDate property.voidsetDividendReinvestment(Boolean value) Sets the value of the dividendReinvestment property.voidSets the value of the excessDividendAmount property.voidSets the value of the extraOrdinaryDividends property.voidSets the value of the interestAccrualsMethod property.voidSets the value of the nonCashDividendTreatment property.voidsetNumberOfIndexUnits(BigDecimal value) Sets the value of the numberOfIndexUnits property.voidsetSpecialDividends(Boolean value) Sets the value of the specialDividends property.
-
Field Details
-
dividendReinvestment
-
dividendEntitlement
-
dividendAmount
-
dividendPaymentDate
-
dividendPeriodEffectiveDate
-
dividendPeriodEndDate
-
dividendPeriod
-
extraOrdinaryDividends
-
excessDividendAmount
-
currency
-
determinationMethod
-
currencyReference
-
dividendFxTriggerDate
-
interestAccrualsMethod
-
numberOfIndexUnits
-
declaredCashDividendPercentage
-
declaredCashEquivalentDividendPercentage
-
nonCashDividendTreatment
-
dividendComposition
-
specialDividends
-
-
Constructor Details
-
DividendConditions
public DividendConditions()
-
-
Method Details
-
isDividendReinvestment
-
setDividendReinvestment
-
getDividendEntitlement
Gets the value of the dividendEntitlement property.- Returns:
- possible object is
DividendEntitlementEnum
-
setDividendEntitlement
Sets the value of the dividendEntitlement property.- Parameters:
value- allowed object isDividendEntitlementEnum
-
getDividendAmount
Gets the value of the dividendAmount property.- Returns:
- possible object is
DividendAmountTypeEnum
-
setDividendAmount
Sets the value of the dividendAmount property.- Parameters:
value- allowed object isDividendAmountTypeEnum
-
getDividendPaymentDate
Gets the value of the dividendPaymentDate property.- Returns:
- possible object is
DividendPaymentDate
-
setDividendPaymentDate
Sets the value of the dividendPaymentDate property.- Parameters:
value- allowed object isDividendPaymentDate
-
getDividendPeriodEffectiveDate
Gets the value of the dividendPeriodEffectiveDate property.- Returns:
- possible object is
DateReference
-
setDividendPeriodEffectiveDate
Sets the value of the dividendPeriodEffectiveDate property.- Parameters:
value- allowed object isDateReference
-
getDividendPeriodEndDate
Gets the value of the dividendPeriodEndDate property.- Returns:
- possible object is
DateReference
-
setDividendPeriodEndDate
Sets the value of the dividendPeriodEndDate property.- Parameters:
value- allowed object isDateReference
-
getDividendPeriod
Gets the value of the dividendPeriod property.- Returns:
- possible object is
DividendPeriodEnum
-
setDividendPeriod
Sets the value of the dividendPeriod property.- Parameters:
value- allowed object isDividendPeriodEnum
-
getExtraOrdinaryDividends
Gets the value of the extraOrdinaryDividends property.- Returns:
- possible object is
PartyReference
-
setExtraOrdinaryDividends
Sets the value of the extraOrdinaryDividends property.- Parameters:
value- allowed object isPartyReference
-
getExcessDividendAmount
Gets the value of the excessDividendAmount property.- Returns:
- possible object is
DividendAmountTypeEnum
-
setExcessDividendAmount
Sets the value of the excessDividendAmount property.- Parameters:
value- allowed object isDividendAmountTypeEnum
-
getCurrency
Gets the value of the currency property.- Returns:
- possible object is
IdentifiedCurrency
-
setCurrency
Sets the value of the currency property.- Parameters:
value- allowed object isIdentifiedCurrency
-
getDeterminationMethod
Gets the value of the determinationMethod property.- Returns:
- possible object is
DeterminationMethod
-
setDeterminationMethod
Sets the value of the determinationMethod property.- Parameters:
value- allowed object isDeterminationMethod
-
getCurrencyReference
Gets the value of the currencyReference property.- Returns:
- possible object is
IdentifiedCurrencyReference
-
setCurrencyReference
Sets the value of the currencyReference property.- Parameters:
value- allowed object isIdentifiedCurrencyReference
-
getDividendFxTriggerDate
Gets the value of the dividendFxTriggerDate property.- Returns:
- possible object is
DividendPaymentDate
-
setDividendFxTriggerDate
Sets the value of the dividendFxTriggerDate property.- Parameters:
value- allowed object isDividendPaymentDate
-
getInterestAccrualsMethod
Gets the value of the interestAccrualsMethod property.- Returns:
- possible object is
InterestAccrualsCompoundingMethod
-
setInterestAccrualsMethod
Sets the value of the interestAccrualsMethod property.- Parameters:
value- allowed object isInterestAccrualsCompoundingMethod
-
getNumberOfIndexUnits
Gets the value of the numberOfIndexUnits property.- Returns:
- possible object is
BigDecimal
-
setNumberOfIndexUnits
Sets the value of the numberOfIndexUnits property.- Parameters:
value- allowed object isBigDecimal
-
getDeclaredCashDividendPercentage
Gets the value of the declaredCashDividendPercentage property.- Returns:
- possible object is
BigDecimal
-
setDeclaredCashDividendPercentage
Sets the value of the declaredCashDividendPercentage property.- Parameters:
value- allowed object isBigDecimal
-
getDeclaredCashEquivalentDividendPercentage
Gets the value of the declaredCashEquivalentDividendPercentage property.- Returns:
- possible object is
BigDecimal
-
setDeclaredCashEquivalentDividendPercentage
Sets the value of the declaredCashEquivalentDividendPercentage property.- Parameters:
value- allowed object isBigDecimal
-
getNonCashDividendTreatment
Gets the value of the nonCashDividendTreatment property.- Returns:
- possible object is
NonCashDividendTreatmentEnum
-
setNonCashDividendTreatment
Sets the value of the nonCashDividendTreatment property.- Parameters:
value- allowed object isNonCashDividendTreatmentEnum
-
getDividendComposition
Gets the value of the dividendComposition property.- Returns:
- possible object is
DividendCompositionEnum
-
setDividendComposition
Sets the value of the dividendComposition property.- Parameters:
value- allowed object isDividendCompositionEnum
-
isSpecialDividends
-
setSpecialDividends
-