Package net.finmath.smartcontract.product.xml

Class DividendPayout

java.lang.Object

net.finmath.smartcontract.product.xml.DividendPayout

public class DividendPayout
extends Object

A type describing the dividend payout ratio associated with an equity underlyer. In certain cases the actual ratio is not known on trade inception, and only general conditions are then specified.

Java class for DividendPayout complex type.

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

 <complexType name="DividendPayout">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <choice>
           <sequence>
             <element name="dividendPayoutRatio" type="{http://www.w3.org/2001/XMLSchema}decimal"/>
             <element name="dividendPayoutRatioCash" type="{http://www.w3.org/2001/XMLSchema}decimal" minOccurs="0"/>
             <element name="dividendPayoutRatioNonCash" type="{http://www.w3.org/2001/XMLSchema}decimal" minOccurs="0"/>
           </sequence>
           <element name="dividendPayoutConditions" type="{http://www.fpml.org/FpML-5/confirmation}String"/>
         </choice>
         <element name="dividendPayment" type="{http://www.fpml.org/FpML-5/confirmation}PendingPayment" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field	Description
protected List<PendingPayment>	dividendPayment
protected String	dividendPayoutConditions
protected BigDecimal	dividendPayoutRatio
protected BigDecimal	dividendPayoutRatioCash
protected BigDecimal	dividendPayoutRatioNonCash

Constructor Summary

Constructors

Constructor	Description
DividendPayout()

Method Summary

Modifier and Type	Method	Description
List<PendingPayment>	getDividendPayment()	Gets the value of the dividendPayment property.
String	getDividendPayoutConditions()	Gets the value of the dividendPayoutConditions property.
BigDecimal	getDividendPayoutRatio()	Gets the value of the dividendPayoutRatio property.
BigDecimal	getDividendPayoutRatioCash()	Gets the value of the dividendPayoutRatioCash property.
BigDecimal	getDividendPayoutRatioNonCash()	Gets the value of the dividendPayoutRatioNonCash property.
void	setDividendPayoutConditions(String value)	Sets the value of the dividendPayoutConditions property.
void	setDividendPayoutRatio(BigDecimal value)	Sets the value of the dividendPayoutRatio property.
void	setDividendPayoutRatioCash(BigDecimal value)	Sets the value of the dividendPayoutRatioCash property.
void	setDividendPayoutRatioNonCash(BigDecimal value)	Sets the value of the dividendPayoutRatioNonCash property.

Methods inherited from class java.lang.Object

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

Field Details

dividendPayoutRatio

protected BigDecimal dividendPayoutRatio

dividendPayoutRatioCash

protected BigDecimal dividendPayoutRatioCash

dividendPayoutRatioNonCash

protected BigDecimal dividendPayoutRatioNonCash

dividendPayoutConditions

protected String dividendPayoutConditions

dividendPayment

protected List<PendingPayment> dividendPayment

Constructor Details

DividendPayout

public DividendPayout()

Method Details

getDividendPayoutRatio

public BigDecimal getDividendPayoutRatio()

Gets the value of the dividendPayoutRatio property.

Returns:

possible object is BigDecimal

setDividendPayoutRatio

public void setDividendPayoutRatio(BigDecimal value)

Sets the value of the dividendPayoutRatio property.

Parameters:

value - allowed object is BigDecimal

getDividendPayoutRatioCash

public BigDecimal getDividendPayoutRatioCash()

Gets the value of the dividendPayoutRatioCash property.

Returns:

possible object is BigDecimal

setDividendPayoutRatioCash

public void setDividendPayoutRatioCash(BigDecimal value)

Sets the value of the dividendPayoutRatioCash property.

Parameters:

value - allowed object is BigDecimal

getDividendPayoutRatioNonCash

public BigDecimal getDividendPayoutRatioNonCash()

Gets the value of the dividendPayoutRatioNonCash property.

Returns:

possible object is BigDecimal

setDividendPayoutRatioNonCash

public void setDividendPayoutRatioNonCash(BigDecimal value)

Sets the value of the dividendPayoutRatioNonCash property.

Parameters:

value - allowed object is BigDecimal

getDividendPayoutConditions

public String getDividendPayoutConditions()

Gets the value of the dividendPayoutConditions property.

Returns:

possible object is String

setDividendPayoutConditions

public void setDividendPayoutConditions(String value)

Sets the value of the dividendPayoutConditions property.

Parameters:

value - allowed object is String

getDividendPayment

public List<PendingPayment> getDividendPayment()

Gets the value of the dividendPayment 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 dividendPayment property.

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

    getDividendPayment().add(newItem);
 

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