Package net.finmath.smartcontract.product.xml

Class DividendPeriodDividend

java.lang.Object

net.finmath.smartcontract.product.xml.DividendPeriod

net.finmath.smartcontract.product.xml.DividendPeriodDividend

public class DividendPeriodDividend
extends DividendPeriod

A time bounded dividend period, with an expected dividend for each period.

Java class for DividendPeriodDividend complex type.

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

 <complexType name="DividendPeriodDividend">
   <complexContent>
     <extension base="{http://www.fpml.org/FpML-5/confirmation}DividendPeriod">
       <sequence>
         <element name="dividend" type="{http://www.fpml.org/FpML-5/confirmation}NonNegativeMoney"/>
         <element name="multiplier" type="{http://www.fpml.org/FpML-5/confirmation}PositiveDecimal"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field	Description
protected NonNegativeMoney	dividend
protected BigDecimal	multiplier

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

dateAdjustments, id, unadjustedEndDate, unadjustedStartDate, underlyerReference

Constructor Summary

Constructors

Constructor	Description
DividendPeriodDividend()

Method Summary

Modifier and Type	Method	Description
NonNegativeMoney	getDividend()	Gets the value of the dividend property.
BigDecimal	getMultiplier()	Gets the value of the multiplier property.
void	setDividend(NonNegativeMoney value)	Sets the value of the dividend property.
void	setMultiplier(BigDecimal value)	Sets the value of the multiplier property.

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

getDateAdjustments, getId, getUnadjustedEndDate, getUnadjustedStartDate, getUnderlyerReference, setDateAdjustments, setId, setUnadjustedEndDate, setUnadjustedStartDate, setUnderlyerReference

Methods inherited from class java.lang.Object

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

Field Details

dividend

protected NonNegativeMoney dividend

multiplier

protected BigDecimal multiplier

Constructor Details

DividendPeriodDividend

public DividendPeriodDividend()

Method Details

getDividend

public NonNegativeMoney getDividend()

Gets the value of the dividend property.

Returns:

possible object is NonNegativeMoney

setDividend

public void setDividend(NonNegativeMoney value)

Sets the value of the dividend property.

Parameters:

value - allowed object is NonNegativeMoney

getMultiplier

public BigDecimal getMultiplier()

Gets the value of the multiplier property.

Returns:

possible object is BigDecimal

setMultiplier

public void setMultiplier(BigDecimal value)

Sets the value of the multiplier property.

Parameters:

value - allowed object is BigDecimal