Package net.finmath.smartcontract.product.xml

Class PeriodicPayment

java.lang.Object

net.finmath.smartcontract.product.xml.PaymentBase

net.finmath.smartcontract.product.xml.PeriodicPayment

public class PeriodicPayment
extends PaymentBase

Java class for PeriodicPayment complex type.

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

 <complexType name="PeriodicPayment">
   <complexContent>
     <extension base="{http://www.fpml.org/FpML-5/confirmation}PaymentBase">
       <sequence>
         <element name="paymentFrequency" type="{http://www.fpml.org/FpML-5/confirmation}Period" minOccurs="0"/>
         <element name="firstPeriodStartDate" type="{http://www.w3.org/2001/XMLSchema}date" minOccurs="0"/>
         <element name="firstPaymentDate" type="{http://www.w3.org/2001/XMLSchema}date" minOccurs="0"/>
         <element name="lastRegularPaymentDate" type="{http://www.w3.org/2001/XMLSchema}date" minOccurs="0"/>
         <element name="rollConvention" type="{http://www.fpml.org/FpML-5/confirmation}RollConventionEnum" minOccurs="0"/>
         <choice>
           <element name="fixedAmount" type="{http://www.fpml.org/FpML-5/confirmation}Money"/>
           <element name="fixedAmountCalculation" type="{http://www.fpml.org/FpML-5/confirmation}FixedAmountCalculation"/>
           <element name="floatingAmountCalculation" type="{http://www.fpml.org/FpML-5/confirmation}FloatingAmountCalculation"/>
         </choice>
         <element name="adjustedPaymentDates" type="{http://www.fpml.org/FpML-5/confirmation}AdjustedPaymentDates" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field	Description
protected List<AdjustedPaymentDates>	adjustedPaymentDates
protected XMLGregorianCalendar	firstPaymentDate
protected XMLGregorianCalendar	firstPeriodStartDate
protected Money	fixedAmount
protected FixedAmountCalculation	fixedAmountCalculation
protected FloatingAmountCalculation	floatingAmountCalculation
protected XMLGregorianCalendar	lastRegularPaymentDate
protected Period	paymentFrequency
protected String	rollConvention

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

id

Constructor Summary

Constructors

Constructor	Description
PeriodicPayment()

Method Summary

Modifier and Type	Method	Description
List<AdjustedPaymentDates>	getAdjustedPaymentDates()	Gets the value of the adjustedPaymentDates property.
XMLGregorianCalendar	getFirstPaymentDate()	Gets the value of the firstPaymentDate property.
XMLGregorianCalendar	getFirstPeriodStartDate()	Gets the value of the firstPeriodStartDate property.
Money	getFixedAmount()	Gets the value of the fixedAmount property.
FixedAmountCalculation	getFixedAmountCalculation()	Gets the value of the fixedAmountCalculation property.
FloatingAmountCalculation	getFloatingAmountCalculation()	Gets the value of the floatingAmountCalculation property.
XMLGregorianCalendar	getLastRegularPaymentDate()	Gets the value of the lastRegularPaymentDate property.
Period	getPaymentFrequency()	Gets the value of the paymentFrequency property.
String	getRollConvention()	Gets the value of the rollConvention property.
void	setFirstPaymentDate(XMLGregorianCalendar value)	Sets the value of the firstPaymentDate property.
void	setFirstPeriodStartDate(XMLGregorianCalendar value)	Sets the value of the firstPeriodStartDate property.
void	setFixedAmount(Money value)	Sets the value of the fixedAmount property.
void	setFixedAmountCalculation(FixedAmountCalculation value)	Sets the value of the fixedAmountCalculation property.
void	setFloatingAmountCalculation(FloatingAmountCalculation value)	Sets the value of the floatingAmountCalculation property.
void	setLastRegularPaymentDate(XMLGregorianCalendar value)	Sets the value of the lastRegularPaymentDate property.
void	setPaymentFrequency(Period value)	Sets the value of the paymentFrequency property.
void	setRollConvention(String value)	Sets the value of the rollConvention property.

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

getId, setId

Methods inherited from class java.lang.Object

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

Field Details

paymentFrequency

protected Period paymentFrequency

firstPeriodStartDate

protected XMLGregorianCalendar firstPeriodStartDate

firstPaymentDate

protected XMLGregorianCalendar firstPaymentDate

lastRegularPaymentDate

protected XMLGregorianCalendar lastRegularPaymentDate

rollConvention

protected String rollConvention

fixedAmount

protected Money fixedAmount

fixedAmountCalculation

protected FixedAmountCalculation fixedAmountCalculation

floatingAmountCalculation

protected FloatingAmountCalculation floatingAmountCalculation

adjustedPaymentDates

protected List<AdjustedPaymentDates> adjustedPaymentDates

Constructor Details

PeriodicPayment

public PeriodicPayment()

Method Details

getPaymentFrequency

public Period getPaymentFrequency()

Gets the value of the paymentFrequency property.

Returns:

possible object is Period

setPaymentFrequency

public void setPaymentFrequency(Period value)

Sets the value of the paymentFrequency property.

Parameters:

value - allowed object is Period

getFirstPeriodStartDate

public XMLGregorianCalendar getFirstPeriodStartDate()

Gets the value of the firstPeriodStartDate property.

Returns:

possible object is XMLGregorianCalendar

setFirstPeriodStartDate

public void setFirstPeriodStartDate(XMLGregorianCalendar value)

Sets the value of the firstPeriodStartDate property.

Parameters:

value - allowed object is XMLGregorianCalendar

getFirstPaymentDate

public XMLGregorianCalendar getFirstPaymentDate()

Gets the value of the firstPaymentDate property.

Returns:

possible object is XMLGregorianCalendar

setFirstPaymentDate

public void setFirstPaymentDate(XMLGregorianCalendar value)

Sets the value of the firstPaymentDate property.

Parameters:

value - allowed object is XMLGregorianCalendar

getLastRegularPaymentDate

public XMLGregorianCalendar getLastRegularPaymentDate()

Gets the value of the lastRegularPaymentDate property.

Returns:

possible object is XMLGregorianCalendar

setLastRegularPaymentDate

public void setLastRegularPaymentDate(XMLGregorianCalendar value)

Sets the value of the lastRegularPaymentDate property.

Parameters:

value - allowed object is XMLGregorianCalendar

getRollConvention

public String getRollConvention()

Gets the value of the rollConvention property.

Returns:

possible object is String

setRollConvention

public void setRollConvention(String value)

Sets the value of the rollConvention property.

Parameters:

value - allowed object is String

getFixedAmount

public Money getFixedAmount()

Gets the value of the fixedAmount property.

Returns:

possible object is Money

setFixedAmount

public void setFixedAmount(Money value)

Sets the value of the fixedAmount property.

Parameters:

value - allowed object is Money

getFixedAmountCalculation

public FixedAmountCalculation getFixedAmountCalculation()

Gets the value of the fixedAmountCalculation property.

Returns:

possible object is FixedAmountCalculation

setFixedAmountCalculation

public void setFixedAmountCalculation(FixedAmountCalculation value)

Sets the value of the fixedAmountCalculation property.

Parameters:

value - allowed object is FixedAmountCalculation

getFloatingAmountCalculation

public FloatingAmountCalculation getFloatingAmountCalculation()

Gets the value of the floatingAmountCalculation property.

Returns:

possible object is FloatingAmountCalculation

setFloatingAmountCalculation

public void setFloatingAmountCalculation(FloatingAmountCalculation value)

Sets the value of the floatingAmountCalculation property.

Parameters:

value - allowed object is FloatingAmountCalculation

getAdjustedPaymentDates

public List<AdjustedPaymentDates> getAdjustedPaymentDates()

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

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

    getAdjustedPaymentDates().add(newItem);
 

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