Package net.finmath.smartcontract.product.xml

Class FxTargetSettlementPeriod

java.lang.Object

net.finmath.smartcontract.product.xml.SettlementPeriod

net.finmath.smartcontract.product.xml.FxTargetSettlementPeriod

public class FxTargetSettlementPeriod
extends SettlementPeriod

Java class for FxTargetSettlementPeriod complex type.

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

 <complexType name="FxTargetSettlementPeriod">
   <complexContent>
     <extension base="{http://www.fpml.org/FpML-5/confirmation}SettlementPeriod">
       <sequence>
         <element name="pivot" type="{http://www.w3.org/2001/XMLSchema}decimal" minOccurs="0"/>
         <element name="payoff" type="{http://www.fpml.org/FpML-5/confirmation}FxTargetSettlementPeriodPayoff" maxOccurs="unbounded"/>
         <element name="barrier" type="{http://www.fpml.org/FpML-5/confirmation}FxSettlementPeriodBarrier" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field	Description
protected List<FxSettlementPeriodBarrier>	barrier
protected List<FxTargetSettlementPeriodPayoff>	payoff
protected BigDecimal	pivot

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

expiryDate, notionalAmount, settlementDate

Constructor Summary

Constructors

Constructor	Description
FxTargetSettlementPeriod()

Method Summary

Modifier and Type	Method	Description
List<FxSettlementPeriodBarrier>	getBarrier()	Gets the value of the barrier property.
List<FxTargetSettlementPeriodPayoff>	getPayoff()	Gets the value of the payoff property.
BigDecimal	getPivot()	Gets the value of the pivot property.
void	setPivot(BigDecimal value)	Sets the value of the pivot property.

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

getExpiryDate, getNotionalAmount, getSettlementDate, setExpiryDate, setNotionalAmount, setSettlementDate

Methods inherited from class java.lang.Object

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

Field Details

pivot

protected BigDecimal pivot

payoff

protected List<FxTargetSettlementPeriodPayoff> payoff

barrier

protected List<FxSettlementPeriodBarrier> barrier

Constructor Details

FxTargetSettlementPeriod

public FxTargetSettlementPeriod()

Method Details

getPivot

public BigDecimal getPivot()

Gets the value of the pivot property.

Returns:

possible object is BigDecimal

setPivot

public void setPivot(BigDecimal value)

Sets the value of the pivot property.

Parameters:

value - allowed object is BigDecimal

getPayoff

public List<FxTargetSettlementPeriodPayoff> getPayoff()

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

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

    getPayoff().add(newItem);
 

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

getBarrier

public List<FxSettlementPeriodBarrier> getBarrier()

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

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

    getBarrier().add(newItem);
 

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