Package net.finmath.smartcontract.product.xml

Class FxTargetLinearPayoffRegion

java.lang.Object

net.finmath.smartcontract.product.xml.FxTargetPayoffRegion

net.finmath.smartcontract.product.xml.FxTargetLinearPayoffRegion

public class FxTargetLinearPayoffRegion
extends FxTargetPayoffRegion

A fixing region in which the payoff varies linearly with the fixing value.

Java class for FxTargetLinearPayoffRegion complex type.

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

 <complexType name="FxTargetLinearPayoffRegion">
   <complexContent>
     <extension base="{http://www.fpml.org/FpML-5/confirmation}FxTargetPayoffRegion">
       <sequence>
         <group ref="{http://www.fpml.org/FpML-5/confirmation}FxExchangedCurrency.model"/>
         <element name="strike" type="{http://www.fpml.org/FpML-5/confirmation}FxStrike"/>
         <element name="counterCurrencyAmount" type="{http://www.fpml.org/FpML-5/confirmation}NonNegativeAmountSchedule" minOccurs="0"/>
         <element name="lowerBound" type="{http://www.fpml.org/FpML-5/confirmation}FxTargetRegionLowerBound" minOccurs="0"/>
         <element name="upperBound" type="{http://www.fpml.org/FpML-5/confirmation}FxTargetRegionUpperBound" minOccurs="0"/>
         <element name="leverage" type="{http://www.fpml.org/FpML-5/confirmation}FxTargetLeverage" minOccurs="0"/>
         <element name="payoffCap" type="{http://www.fpml.org/FpML-5/confirmation}FxPayoffCap" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field	Description
protected NonNegativeAmountSchedule	counterCurrencyAmount
protected FxExchangedCurrency	exchangedCurrency1
protected FxExchangedCurrency	exchangedCurrency2
protected FxTargetLeverage	leverage
protected FxTargetRegionLowerBound	lowerBound
protected List<FxPayoffCap>	payoffCap
protected FxStrike	strike
protected FxTargetRegionUpperBound	upperBound

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

id

Constructor Summary

Constructors

Constructor	Description
FxTargetLinearPayoffRegion()

Method Summary

Modifier and Type	Method	Description
NonNegativeAmountSchedule	getCounterCurrencyAmount()	Gets the value of the counterCurrencyAmount property.
FxExchangedCurrency	getExchangedCurrency1()	Gets the value of the exchangedCurrency1 property.
FxExchangedCurrency	getExchangedCurrency2()	Gets the value of the exchangedCurrency2 property.
FxTargetLeverage	getLeverage()	Gets the value of the leverage property.
FxTargetRegionLowerBound	getLowerBound()	Gets the value of the lowerBound property.
List<FxPayoffCap>	getPayoffCap()	Gets the value of the payoffCap property.
FxStrike	getStrike()	Gets the value of the strike property.
FxTargetRegionUpperBound	getUpperBound()	Gets the value of the upperBound property.
void	setCounterCurrencyAmount(NonNegativeAmountSchedule value)	Sets the value of the counterCurrencyAmount property.
void	setExchangedCurrency1(FxExchangedCurrency value)	Sets the value of the exchangedCurrency1 property.
void	setExchangedCurrency2(FxExchangedCurrency value)	Sets the value of the exchangedCurrency2 property.
void	setLeverage(FxTargetLeverage value)	Sets the value of the leverage property.
void	setLowerBound(FxTargetRegionLowerBound value)	Sets the value of the lowerBound property.
void	setStrike(FxStrike value)	Sets the value of the strike property.
void	setUpperBound(FxTargetRegionUpperBound value)	Sets the value of the upperBound property.

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

getId, setId

Methods inherited from class java.lang.Object

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

Field Details

exchangedCurrency1

protected FxExchangedCurrency exchangedCurrency1

exchangedCurrency2

protected FxExchangedCurrency exchangedCurrency2

strike

protected FxStrike strike

counterCurrencyAmount

protected NonNegativeAmountSchedule counterCurrencyAmount

lowerBound

protected FxTargetRegionLowerBound lowerBound

upperBound

protected FxTargetRegionUpperBound upperBound

leverage

protected FxTargetLeverage leverage

payoffCap

protected List<FxPayoffCap> payoffCap

Constructor Details

FxTargetLinearPayoffRegion

public FxTargetLinearPayoffRegion()

Method Details

getExchangedCurrency1

public FxExchangedCurrency getExchangedCurrency1()

Gets the value of the exchangedCurrency1 property.

Returns:

possible object is FxExchangedCurrency

setExchangedCurrency1

public void setExchangedCurrency1(FxExchangedCurrency value)

Sets the value of the exchangedCurrency1 property.

Parameters:

value - allowed object is FxExchangedCurrency

getExchangedCurrency2

public FxExchangedCurrency getExchangedCurrency2()

Gets the value of the exchangedCurrency2 property.

Returns:

possible object is FxExchangedCurrency

setExchangedCurrency2

public void setExchangedCurrency2(FxExchangedCurrency value)

Sets the value of the exchangedCurrency2 property.

Parameters:

value - allowed object is FxExchangedCurrency

getStrike

public FxStrike getStrike()

Gets the value of the strike property.

Returns:

possible object is FxStrike

setStrike

public void setStrike(FxStrike value)

Sets the value of the strike property.

Parameters:

value - allowed object is FxStrike

getCounterCurrencyAmount

public NonNegativeAmountSchedule getCounterCurrencyAmount()

Gets the value of the counterCurrencyAmount property.

Returns:

possible object is NonNegativeAmountSchedule

setCounterCurrencyAmount

public void setCounterCurrencyAmount(NonNegativeAmountSchedule value)

Sets the value of the counterCurrencyAmount property.

Parameters:

value - allowed object is NonNegativeAmountSchedule

getLowerBound

public FxTargetRegionLowerBound getLowerBound()

Gets the value of the lowerBound property.

Returns:

possible object is FxTargetRegionLowerBound

setLowerBound

public void setLowerBound(FxTargetRegionLowerBound value)

Sets the value of the lowerBound property.

Parameters:

value - allowed object is FxTargetRegionLowerBound

getUpperBound

public FxTargetRegionUpperBound getUpperBound()

Gets the value of the upperBound property.

Returns:

possible object is FxTargetRegionUpperBound

setUpperBound

public void setUpperBound(FxTargetRegionUpperBound value)

Sets the value of the upperBound property.

Parameters:

value - allowed object is FxTargetRegionUpperBound

getLeverage

public FxTargetLeverage getLeverage()

Gets the value of the leverage property.

Returns:

possible object is FxTargetLeverage

setLeverage

public void setLeverage(FxTargetLeverage value)

Sets the value of the leverage property.

Parameters:

value - allowed object is FxTargetLeverage

getPayoffCap

public List<FxPayoffCap> getPayoffCap()

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

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

    getPayoffCap().add(newItem);
 

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