Package net.finmath.smartcontract.product.xml

Class FxStraddle

java.lang.Object

net.finmath.smartcontract.product.xml.FxStraddle

public class FxStraddle
extends Object

Straddle details. Straddle is composed of two options: a call and a put involving the quotedCurrencyPair.

Java class for FxStraddle complex type.

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

 <complexType name="FxStraddle">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="straddleType" type="{http://www.fpml.org/FpML-5/confirmation}FxStraddleTypeEnum"/>
         <element name="tenorPeriod" type="{http://www.fpml.org/FpML-5/confirmation}Period" minOccurs="0"/>
         <sequence>
           <element name="europeanExercise" type="{http://www.fpml.org/FpML-5/confirmation}FxEuropeanExercise"/>
           <element name="exerciseProcedure" type="{http://www.fpml.org/FpML-5/confirmation}ExerciseProcedure" minOccurs="0"/>
         </sequence>
         <sequence>
           <element name="notional" type="{http://www.fpml.org/FpML-5/confirmation}NonNegativeMoney"/>
           <element name="counterCurrency" type="{http://www.fpml.org/FpML-5/confirmation}Currency"/>
         </sequence>
         <element name="premium" type="{http://www.fpml.org/FpML-5/confirmation}FxStraddlePremium" maxOccurs="unbounded" minOccurs="0"/>
         <element name="settlementDate" type="{http://www.fpml.org/FpML-5/confirmation}AdjustableOrAdjustedDate" minOccurs="0"/>
         <element name="cashSettlement" type="{http://www.fpml.org/FpML-5/confirmation}FxCashSettlementSimple" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field	Description
protected FxCashSettlementSimple	cashSettlement
protected Currency	counterCurrency
protected FxEuropeanExercise	europeanExercise
protected ExerciseProcedure	exerciseProcedure
protected NonNegativeMoney	notional
protected List<FxStraddlePremium>	premium
protected AdjustableOrAdjustedDate	settlementDate
protected FxStraddleTypeEnum	straddleType
protected Period	tenorPeriod

Constructor Summary

Constructors

Constructor	Description
FxStraddle()

Method Summary

Modifier and Type	Method	Description
FxCashSettlementSimple	getCashSettlement()	Gets the value of the cashSettlement property.
Currency	getCounterCurrency()	Gets the value of the counterCurrency property.
FxEuropeanExercise	getEuropeanExercise()	Gets the value of the europeanExercise property.
ExerciseProcedure	getExerciseProcedure()	Gets the value of the exerciseProcedure property.
NonNegativeMoney	getNotional()	Gets the value of the notional property.
List<FxStraddlePremium>	getPremium()	Gets the value of the premium property.
AdjustableOrAdjustedDate	getSettlementDate()	Gets the value of the settlementDate property.
FxStraddleTypeEnum	getStraddleType()	Gets the value of the straddleType property.
Period	getTenorPeriod()	Gets the value of the tenorPeriod property.
void	setCashSettlement(FxCashSettlementSimple value)	Sets the value of the cashSettlement property.
void	setCounterCurrency(Currency value)	Sets the value of the counterCurrency property.
void	setEuropeanExercise(FxEuropeanExercise value)	Sets the value of the europeanExercise property.
void	setExerciseProcedure(ExerciseProcedure value)	Sets the value of the exerciseProcedure property.
void	setNotional(NonNegativeMoney value)	Sets the value of the notional property.
void	setSettlementDate(AdjustableOrAdjustedDate value)	Sets the value of the settlementDate property.
void	setStraddleType(FxStraddleTypeEnum value)	Sets the value of the straddleType property.
void	setTenorPeriod(Period value)	Sets the value of the tenorPeriod property.

Methods inherited from class java.lang.Object

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

Field Details

straddleType

protected FxStraddleTypeEnum straddleType

tenorPeriod

protected Period tenorPeriod

europeanExercise

protected FxEuropeanExercise europeanExercise

exerciseProcedure

protected ExerciseProcedure exerciseProcedure

notional

protected NonNegativeMoney notional

counterCurrency

protected Currency counterCurrency

premium

protected List<FxStraddlePremium> premium

settlementDate

protected AdjustableOrAdjustedDate settlementDate

cashSettlement

protected FxCashSettlementSimple cashSettlement

Constructor Details

FxStraddle

public FxStraddle()

Method Details

getStraddleType

public FxStraddleTypeEnum getStraddleType()

Gets the value of the straddleType property.

Returns:

possible object is FxStraddleTypeEnum

setStraddleType

public void setStraddleType(FxStraddleTypeEnum value)

Sets the value of the straddleType property.

Parameters:

value - allowed object is FxStraddleTypeEnum

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

getEuropeanExercise

public FxEuropeanExercise getEuropeanExercise()

Gets the value of the europeanExercise property.

Returns:

possible object is FxEuropeanExercise

setEuropeanExercise

public void setEuropeanExercise(FxEuropeanExercise value)

Sets the value of the europeanExercise property.

Parameters:

value - allowed object is FxEuropeanExercise

getExerciseProcedure

public ExerciseProcedure getExerciseProcedure()

Gets the value of the exerciseProcedure property.

Returns:

possible object is ExerciseProcedure

setExerciseProcedure

public void setExerciseProcedure(ExerciseProcedure value)

Sets the value of the exerciseProcedure property.

Parameters:

value - allowed object is ExerciseProcedure

getNotional

public NonNegativeMoney getNotional()

Gets the value of the notional property.

Returns:

possible object is NonNegativeMoney

setNotional

public void setNotional(NonNegativeMoney value)

Sets the value of the notional property.

Parameters:

value - allowed object is NonNegativeMoney

getCounterCurrency

public Currency getCounterCurrency()

Gets the value of the counterCurrency property.

Returns:

possible object is Currency

setCounterCurrency

public void setCounterCurrency(Currency value)

Sets the value of the counterCurrency property.

Parameters:

value - allowed object is Currency

getPremium

public List<FxStraddlePremium> getPremium()

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

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

    getPremium().add(newItem);
 

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

getSettlementDate

public AdjustableOrAdjustedDate getSettlementDate()

Gets the value of the settlementDate property.

Returns:

possible object is AdjustableOrAdjustedDate

setSettlementDate

public void setSettlementDate(AdjustableOrAdjustedDate value)

Sets the value of the settlementDate property.

Parameters:

value - allowed object is AdjustableOrAdjustedDate

getCashSettlement

public FxCashSettlementSimple getCashSettlement()

Gets the value of the cashSettlement property.

Returns:

possible object is FxCashSettlementSimple

setCashSettlement

public void setCashSettlement(FxCashSettlementSimple value)

Sets the value of the cashSettlement property.

Parameters:

value - allowed object is FxCashSettlementSimple