Package net.finmath.smartcontract.product.xml

Class DividendPeriodPayment

java.lang.Object

net.finmath.smartcontract.product.xml.DividendPeriod

net.finmath.smartcontract.product.xml.DividendPeriodPayment

public class DividendPeriodPayment
extends DividendPeriod

A time bounded dividend period, with fixed strike and a dividend payment date per period.

Java class for DividendPeriodPayment complex type.

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

 <complexType name="DividendPeriodPayment">
   <complexContent>
     <extension base="{http://www.fpml.org/FpML-5/confirmation}DividendPeriod">
       <sequence>
         <element name="fixedStrike" type="{http://www.fpml.org/FpML-5/confirmation}PositiveDecimal"/>
         <element name="paymentDate" type="{http://www.fpml.org/FpML-5/confirmation}AdjustableOrRelativeDate"/>
         <element name="valuationDate" type="{http://www.fpml.org/FpML-5/confirmation}AdjustableOrRelativeDate" minOccurs="0"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field	Description
protected BigDecimal	fixedStrike
protected AdjustableOrRelativeDate	paymentDate
protected AdjustableOrRelativeDate	valuationDate

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

dateAdjustments, id, unadjustedEndDate, unadjustedStartDate, underlyerReference

Constructor Summary

Constructors

Constructor	Description
DividendPeriodPayment()

Method Summary

Modifier and Type	Method	Description
BigDecimal	getFixedStrike()	Gets the value of the fixedStrike property.
AdjustableOrRelativeDate	getPaymentDate()	Gets the value of the paymentDate property.
AdjustableOrRelativeDate	getValuationDate()	Gets the value of the valuationDate property.
void	setFixedStrike(BigDecimal value)	Sets the value of the fixedStrike property.
void	setPaymentDate(AdjustableOrRelativeDate value)	Sets the value of the paymentDate property.
void	setValuationDate(AdjustableOrRelativeDate value)	Sets the value of the valuationDate 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

fixedStrike

protected BigDecimal fixedStrike

paymentDate

protected AdjustableOrRelativeDate paymentDate

valuationDate

protected AdjustableOrRelativeDate valuationDate

Constructor Details

DividendPeriodPayment

public DividendPeriodPayment()

Method Details

getFixedStrike

public BigDecimal getFixedStrike()

Gets the value of the fixedStrike property.

Returns:

possible object is BigDecimal

setFixedStrike

public void setFixedStrike(BigDecimal value)

Sets the value of the fixedStrike property.

Parameters:

value - allowed object is BigDecimal

getPaymentDate

public AdjustableOrRelativeDate getPaymentDate()

Gets the value of the paymentDate property.

Returns:

possible object is AdjustableOrRelativeDate

setPaymentDate

public void setPaymentDate(AdjustableOrRelativeDate value)

Sets the value of the paymentDate property.

Parameters:

value - allowed object is AdjustableOrRelativeDate

getValuationDate

public AdjustableOrRelativeDate getValuationDate()

Gets the value of the valuationDate property.

Returns:

possible object is AdjustableOrRelativeDate

setValuationDate

public void setValuationDate(AdjustableOrRelativeDate value)

Sets the value of the valuationDate property.

Parameters:

value - allowed object is AdjustableOrRelativeDate