Package net.finmath.smartcontract.product.xml

Class FxSingleLeg

java.lang.Object

net.finmath.smartcontract.product.xml.Product

net.finmath.smartcontract.product.xml.FxSingleLeg

public class FxSingleLeg
extends Product

A type defining either a spot or forward FX transactions.

Java class for FxSingleLeg complex type.

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

 <complexType name="FxSingleLeg">
   <complexContent>
     <extension base="{http://www.fpml.org/FpML-5/confirmation}Product">
       <sequence>
         <group ref="{http://www.fpml.org/FpML-5/confirmation}FxCoreDetails.model"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field	Description
protected XMLGregorianCalendar	currency1ValueDate
protected XMLGregorianCalendar	currency2ValueDate
protected DealtCurrencyEnum	dealtCurrency
protected List<FxDisruption>	disruption
protected Payment	exchangedCurrency1
protected Payment	exchangedCurrency2
protected ExchangeRate	exchangeRate
protected FxCashSettlement	nonDeliverableSettlement
protected FxTenorPeriodEnum	tenorName
protected Period	tenorPeriod
protected XMLGregorianCalendar	valueDate

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

assetClass, id, primaryAssetClass, productId, productType, secondaryAssetClass

Constructor Summary

Constructors

Constructor	Description
FxSingleLeg()

Method Summary

Modifier and Type	Method	Description
XMLGregorianCalendar	getCurrency1ValueDate()	Gets the value of the currency1ValueDate property.
XMLGregorianCalendar	getCurrency2ValueDate()	Gets the value of the currency2ValueDate property.
DealtCurrencyEnum	getDealtCurrency()	Gets the value of the dealtCurrency property.
List<FxDisruption>	getDisruption()	Gets the value of the disruption property.
Payment	getExchangedCurrency1()	Gets the value of the exchangedCurrency1 property.
Payment	getExchangedCurrency2()	Gets the value of the exchangedCurrency2 property.
ExchangeRate	getExchangeRate()	Gets the value of the exchangeRate property.
FxCashSettlement	getNonDeliverableSettlement()	Gets the value of the nonDeliverableSettlement property.
FxTenorPeriodEnum	getTenorName()	Gets the value of the tenorName property.
Period	getTenorPeriod()	Gets the value of the tenorPeriod property.
XMLGregorianCalendar	getValueDate()	Gets the value of the valueDate property.
void	setCurrency1ValueDate(XMLGregorianCalendar value)	Sets the value of the currency1ValueDate property.
void	setCurrency2ValueDate(XMLGregorianCalendar value)	Sets the value of the currency2ValueDate property.
void	setDealtCurrency(DealtCurrencyEnum value)	Sets the value of the dealtCurrency property.
void	setExchangedCurrency1(Payment value)	Sets the value of the exchangedCurrency1 property.
void	setExchangedCurrency2(Payment value)	Sets the value of the exchangedCurrency2 property.
void	setExchangeRate(ExchangeRate value)	Sets the value of the exchangeRate property.
void	setNonDeliverableSettlement(FxCashSettlement value)	Sets the value of the nonDeliverableSettlement property.
void	setTenorName(FxTenorPeriodEnum value)	Sets the value of the tenorName property.
void	setTenorPeriod(Period value)	Sets the value of the tenorPeriod property.
void	setValueDate(XMLGregorianCalendar value)	Sets the value of the valueDate property.

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

getAssetClass, getId, getPrimaryAssetClass, getProductId, getProductType, getSecondaryAssetClass, setId, setPrimaryAssetClass

Methods inherited from class java.lang.Object

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

Field Details

exchangedCurrency1

protected Payment exchangedCurrency1

exchangedCurrency2

protected Payment exchangedCurrency2

dealtCurrency

protected DealtCurrencyEnum dealtCurrency

tenorName

protected FxTenorPeriodEnum tenorName

tenorPeriod

protected Period tenorPeriod

valueDate

protected XMLGregorianCalendar valueDate

currency1ValueDate

protected XMLGregorianCalendar currency1ValueDate

currency2ValueDate

protected XMLGregorianCalendar currency2ValueDate

exchangeRate

protected ExchangeRate exchangeRate

nonDeliverableSettlement

protected FxCashSettlement nonDeliverableSettlement

disruption

protected List<FxDisruption> disruption

Constructor Details

FxSingleLeg

public FxSingleLeg()

Method Details

getExchangedCurrency1

public Payment getExchangedCurrency1()

Gets the value of the exchangedCurrency1 property.

Returns:

possible object is Payment

setExchangedCurrency1

public void setExchangedCurrency1(Payment value)

Sets the value of the exchangedCurrency1 property.

Parameters:

value - allowed object is Payment

getExchangedCurrency2

public Payment getExchangedCurrency2()

Gets the value of the exchangedCurrency2 property.

Returns:

possible object is Payment

setExchangedCurrency2

public void setExchangedCurrency2(Payment value)

Sets the value of the exchangedCurrency2 property.

Parameters:

value - allowed object is Payment

getDealtCurrency

public DealtCurrencyEnum getDealtCurrency()

Gets the value of the dealtCurrency property.

Returns:

possible object is DealtCurrencyEnum

setDealtCurrency

public void setDealtCurrency(DealtCurrencyEnum value)

Sets the value of the dealtCurrency property.

Parameters:

value - allowed object is DealtCurrencyEnum

getTenorName

public FxTenorPeriodEnum getTenorName()

Gets the value of the tenorName property.

Returns:

possible object is FxTenorPeriodEnum

setTenorName

public void setTenorName(FxTenorPeriodEnum value)

Sets the value of the tenorName property.

Parameters:

value - allowed object is FxTenorPeriodEnum

getTenorPeriod

public Period getTenorPeriod()

Gets the value of the tenorPeriod property.

Returns:

possible object is Period

setTenorPeriod

public void setTenorPeriod(Period value)

Sets the value of the tenorPeriod property.

Parameters:

value - allowed object is Period

getValueDate

public XMLGregorianCalendar getValueDate()

Gets the value of the valueDate property.

Returns:

possible object is XMLGregorianCalendar

setValueDate

public void setValueDate(XMLGregorianCalendar value)

Sets the value of the valueDate property.

Parameters:

value - allowed object is XMLGregorianCalendar

getCurrency1ValueDate

public XMLGregorianCalendar getCurrency1ValueDate()

Gets the value of the currency1ValueDate property.

Returns:

possible object is XMLGregorianCalendar

setCurrency1ValueDate

public void setCurrency1ValueDate(XMLGregorianCalendar value)

Sets the value of the currency1ValueDate property.

Parameters:

value - allowed object is XMLGregorianCalendar

getCurrency2ValueDate

public XMLGregorianCalendar getCurrency2ValueDate()

Gets the value of the currency2ValueDate property.

Returns:

possible object is XMLGregorianCalendar

setCurrency2ValueDate

public void setCurrency2ValueDate(XMLGregorianCalendar value)

Sets the value of the currency2ValueDate property.

Parameters:

value - allowed object is XMLGregorianCalendar

getExchangeRate

public ExchangeRate getExchangeRate()

Gets the value of the exchangeRate property.

Returns:

possible object is ExchangeRate

setExchangeRate

public void setExchangeRate(ExchangeRate value)

Sets the value of the exchangeRate property.

Parameters:

value - allowed object is ExchangeRate

getNonDeliverableSettlement

public FxCashSettlement getNonDeliverableSettlement()

Gets the value of the nonDeliverableSettlement property.

Returns:

possible object is FxCashSettlement

setNonDeliverableSettlement

public void setNonDeliverableSettlement(FxCashSettlement value)

Sets the value of the nonDeliverableSettlement property.

Parameters:

value - allowed object is FxCashSettlement

getDisruption

public List<FxDisruption> getDisruption()

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

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

    getDisruption().add(newItem);
 

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