Package net.finmath.smartcontract.product.xml

Class DividendPaymentDate

java.lang.Object

net.finmath.smartcontract.product.xml.DividendPaymentDate

public class DividendPaymentDate
extends Object

A type describing the date on which the dividend will be paid/received. This type is also used to specify the date on which the FX rate will be determined, when applicable.

Java class for DividendPaymentDate complex type.

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

 <complexType name="DividendPaymentDate">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <choice>
           <sequence>
             <element name="dividendDateReference" type="{http://www.fpml.org/FpML-5/confirmation}DividendDateReferenceEnum"/>
             <element name="paymentDateOffset" type="{http://www.fpml.org/FpML-5/confirmation}Offset" minOccurs="0"/>
           </sequence>
           <element name="adjustableDate" type="{http://www.fpml.org/FpML-5/confirmation}AdjustableDate"/>
         </choice>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field	Description
protected AdjustableDate	adjustableDate
protected DividendDateReferenceEnum	dividendDateReference
protected Offset	paymentDateOffset

Constructor Summary

Constructors

Constructor	Description
DividendPaymentDate()

Method Summary

Modifier and Type	Method	Description
AdjustableDate	getAdjustableDate()	Gets the value of the adjustableDate property.
DividendDateReferenceEnum	getDividendDateReference()	Gets the value of the dividendDateReference property.
Offset	getPaymentDateOffset()	Gets the value of the paymentDateOffset property.
void	setAdjustableDate(AdjustableDate value)	Sets the value of the adjustableDate property.
void	setDividendDateReference(DividendDateReferenceEnum value)	Sets the value of the dividendDateReference property.
void	setPaymentDateOffset(Offset value)	Sets the value of the paymentDateOffset property.

Methods inherited from class java.lang.Object

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

Field Details

dividendDateReference

protected DividendDateReferenceEnum dividendDateReference

paymentDateOffset

protected Offset paymentDateOffset

adjustableDate

protected AdjustableDate adjustableDate

Constructor Details

DividendPaymentDate

public DividendPaymentDate()

Method Details

getDividendDateReference

public DividendDateReferenceEnum getDividendDateReference()

Gets the value of the dividendDateReference property.

Returns:

possible object is DividendDateReferenceEnum

setDividendDateReference

public void setDividendDateReference(DividendDateReferenceEnum value)

Sets the value of the dividendDateReference property.

Parameters:

value - allowed object is DividendDateReferenceEnum

getPaymentDateOffset

public Offset getPaymentDateOffset()

Gets the value of the paymentDateOffset property.

Returns:

possible object is Offset

setPaymentDateOffset

public void setPaymentDateOffset(Offset value)

Sets the value of the paymentDateOffset property.

Parameters:

value - allowed object is Offset

getAdjustableDate

public AdjustableDate getAdjustableDate()

Gets the value of the adjustableDate property.

Returns:

possible object is AdjustableDate

setAdjustableDate

public void setAdjustableDate(AdjustableDate value)

Sets the value of the adjustableDate property.

Parameters:

value - allowed object is AdjustableDate