Package net.finmath.smartcontract.product.xml

Class DividendLeg

java.lang.Object

net.finmath.smartcontract.product.xml.Leg

net.finmath.smartcontract.product.xml.DirectionalLeg

net.finmath.smartcontract.product.xml.DirectionalLegUnderlyer

net.finmath.smartcontract.product.xml.DividendLeg

public class DividendLeg
extends DirectionalLegUnderlyer

Floating Payment Leg of a Dividend Swap.

Java class for DividendLeg complex type.

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

 <complexType name="DividendLeg">
   <complexContent>
     <extension base="{http://www.fpml.org/FpML-5/confirmation}DirectionalLegUnderlyer">
       <sequence>
         <group ref="{http://www.fpml.org/FpML-5/confirmation}DeclaredCashAndCashEquivalentDividendPercentage.model"/>
         <element name="dividendPeriod" type="{http://www.fpml.org/FpML-5/confirmation}DividendPeriodPayment" maxOccurs="unbounded"/>
         <element name="specialDividends" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="materialDividend" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field	Description
protected BigDecimal	declaredCashDividendPercentage
protected BigDecimal	declaredCashEquivalentDividendPercentage
protected List<DividendPeriodPayment>	dividendPeriod
protected Boolean	materialDividend
protected Boolean	specialDividends

Fields inherited from class net.finmath.smartcontract.product.xml.DirectionalLegUnderlyer

fxFeature, settlementAmount, settlementCurrency, settlementDate, settlementType, underlyer

Fields inherited from class net.finmath.smartcontract.product.xml.DirectionalLeg

effectiveDate, legIdentifier, payerAccountReference, payerPartyReference, receiverAccountReference, receiverPartyReference, terminationDate

Fields inherited from class net.finmath.smartcontract.product.xml.Leg

id

Constructor Summary

Constructors

Constructor	Description
DividendLeg()

Method Summary

Modifier and Type	Method	Description
BigDecimal	getDeclaredCashDividendPercentage()	Gets the value of the declaredCashDividendPercentage property.
BigDecimal	getDeclaredCashEquivalentDividendPercentage()	Gets the value of the declaredCashEquivalentDividendPercentage property.
List<DividendPeriodPayment>	getDividendPeriod()	Gets the value of the dividendPeriod property.
Boolean	isMaterialDividend()	Gets the value of the materialDividend property.
Boolean	isSpecialDividends()	Gets the value of the specialDividends property.
void	setDeclaredCashDividendPercentage(BigDecimal value)	Sets the value of the declaredCashDividendPercentage property.
void	setDeclaredCashEquivalentDividendPercentage(BigDecimal value)	Sets the value of the declaredCashEquivalentDividendPercentage property.
void	setMaterialDividend(Boolean value)	Sets the value of the materialDividend property.
void	setSpecialDividends(Boolean value)	Sets the value of the specialDividends property.

Methods inherited from class net.finmath.smartcontract.product.xml.DirectionalLegUnderlyer

getFxFeature, getSettlementAmount, getSettlementCurrency, getSettlementDate, getSettlementType, getUnderlyer, setFxFeature, setSettlementAmount, setSettlementCurrency, setSettlementDate, setSettlementType, setUnderlyer

Methods inherited from class net.finmath.smartcontract.product.xml.DirectionalLeg

getEffectiveDate, getLegIdentifier, getPayerAccountReference, getPayerPartyReference, getReceiverAccountReference, getReceiverPartyReference, getTerminationDate, setEffectiveDate, setPayerAccountReference, setPayerPartyReference, setReceiverAccountReference, setReceiverPartyReference, setTerminationDate

Methods inherited from class net.finmath.smartcontract.product.xml.Leg

getId, setId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

declaredCashDividendPercentage

protected BigDecimal declaredCashDividendPercentage

declaredCashEquivalentDividendPercentage

protected BigDecimal declaredCashEquivalentDividendPercentage

dividendPeriod

protected List<DividendPeriodPayment> dividendPeriod

specialDividends

protected Boolean specialDividends

materialDividend

protected Boolean materialDividend

Constructor Details

DividendLeg

public DividendLeg()

Method Details

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

getDividendPeriod

public List<DividendPeriodPayment> getDividendPeriod()

Gets the value of the dividendPeriod property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the Jakarta XML Binding object. This is why there is not a set method for the dividendPeriod property.

For example, to add a new item, do as follows:

    getDividendPeriod().add(newItem);
 

Objects of the following type(s) are allowed in the list DividendPeriodPayment

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

isMaterialDividend

public Boolean isMaterialDividend()

Gets the value of the materialDividend property.

Returns:

possible object is Boolean

setMaterialDividend

public void setMaterialDividend(Boolean value)

Sets the value of the materialDividend property.

Parameters:

value - allowed object is Boolean