Package net.finmath.smartcontract.product.xml

Class FxCashSettlement

java.lang.Object

net.finmath.smartcontract.product.xml.FxCashSettlement

public class FxCashSettlement
extends Object

A type that is used for describing cash settlement of an option / non deliverable forward. It includes the currency to settle into together with the fixings required to calculate the currency amount.

Java class for FxCashSettlement complex type.

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

 <complexType name="FxCashSettlement">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="settlementCurrency" type="{http://www.fpml.org/FpML-5/confirmation}Currency"/>
         <element name="referenceCurrency" type="{http://www.fpml.org/FpML-5/confirmation}Currency" minOccurs="0"/>
         <element name="notionalAmount" type="{http://www.fpml.org/FpML-5/confirmation}PositiveMoney" minOccurs="0"/>
         <choice minOccurs="0">
           <element name="fixing" type="{http://www.fpml.org/FpML-5/confirmation}FxFixing" maxOccurs="unbounded"/>
           <element name="rateSourceFixing" type="{http://www.fpml.org/FpML-5/confirmation}FxRateSourceFixing" maxOccurs="unbounded"/>
         </choice>
         <element name="settlementDate" type="{http://www.fpml.org/FpML-5/confirmation}AdjustableDate" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field	Description
protected List<FxFixing>	fixing
protected PositiveMoney	notionalAmount
protected List<FxRateSourceFixing>	rateSourceFixing
protected Currency	referenceCurrency
protected Currency	settlementCurrency
protected AdjustableDate	settlementDate

Constructor Summary

Constructors

Constructor	Description
FxCashSettlement()

Method Summary

Modifier and Type	Method	Description
List<FxFixing>	getFixing()	Gets the value of the fixing property.
PositiveMoney	getNotionalAmount()	Gets the value of the notionalAmount property.
List<FxRateSourceFixing>	getRateSourceFixing()	Gets the value of the rateSourceFixing property.
Currency	getReferenceCurrency()	Gets the value of the referenceCurrency property.
Currency	getSettlementCurrency()	Gets the value of the settlementCurrency property.
AdjustableDate	getSettlementDate()	Gets the value of the settlementDate property.
void	setNotionalAmount(PositiveMoney value)	Sets the value of the notionalAmount property.
void	setReferenceCurrency(Currency value)	Sets the value of the referenceCurrency property.
void	setSettlementCurrency(Currency value)	Sets the value of the settlementCurrency property.
void	setSettlementDate(AdjustableDate value)	Sets the value of the settlementDate property.

Methods inherited from class java.lang.Object

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

Field Details

settlementCurrency

protected Currency settlementCurrency

referenceCurrency

protected Currency referenceCurrency

notionalAmount

protected PositiveMoney notionalAmount

fixing

protected List<FxFixing> fixing

rateSourceFixing

protected List<FxRateSourceFixing> rateSourceFixing

settlementDate

protected AdjustableDate settlementDate

Constructor Details

FxCashSettlement

public FxCashSettlement()

Method Details

getSettlementCurrency

public Currency getSettlementCurrency()

Gets the value of the settlementCurrency property.

Returns:

possible object is Currency

setSettlementCurrency

public void setSettlementCurrency(Currency value)

Sets the value of the settlementCurrency property.

Parameters:

value - allowed object is Currency

getReferenceCurrency

public Currency getReferenceCurrency()

Gets the value of the referenceCurrency property.

Returns:

possible object is Currency

setReferenceCurrency

public void setReferenceCurrency(Currency value)

Sets the value of the referenceCurrency property.

Parameters:

value - allowed object is Currency

getNotionalAmount

public PositiveMoney getNotionalAmount()

Gets the value of the notionalAmount property.

Returns:

possible object is PositiveMoney

setNotionalAmount

public void setNotionalAmount(PositiveMoney value)

Sets the value of the notionalAmount property.

Parameters:

value - allowed object is PositiveMoney

getFixing

public List<FxFixing> getFixing()

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

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

    getFixing().add(newItem);
 

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

getRateSourceFixing

public List<FxRateSourceFixing> getRateSourceFixing()

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

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

    getRateSourceFixing().add(newItem);
 

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

getSettlementDate

public AdjustableDate getSettlementDate()

Gets the value of the settlementDate property.

Returns:

possible object is AdjustableDate

setSettlementDate

public void setSettlementDate(AdjustableDate value)

Sets the value of the settlementDate property.

Parameters:

value - allowed object is AdjustableDate