Package net.finmath.smartcontract.product.xml

Class FxDigitalOption

java.lang.Object

net.finmath.smartcontract.product.xml.Product

net.finmath.smartcontract.product.xml.Option

net.finmath.smartcontract.product.xml.FxDigitalOption

public class FxDigitalOption
extends Option

Describes an option having a triggerable fixed payout.

Java class for FxDigitalOption complex type.

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

 <complexType name="FxDigitalOption">
   <complexContent>
     <extension base="{http://www.fpml.org/FpML-5/confirmation}Option">
       <sequence>
         <element name="effectiveDate" type="{http://www.fpml.org/FpML-5/confirmation}AdjustableOrRelativeDate" minOccurs="0"/>
         <element name="tenorPeriod" type="{http://www.fpml.org/FpML-5/confirmation}Period" minOccurs="0"/>
         <sequence>
           <choice>
             <sequence>
               <element name="americanExercise" type="{http://www.fpml.org/FpML-5/confirmation}FxDigitalAmericanExercise"/>
               <element name="touch" type="{http://www.fpml.org/FpML-5/confirmation}FxTouch" maxOccurs="unbounded"/>
             </sequence>
             <sequence>
               <element name="europeanExercise" type="{http://www.fpml.org/FpML-5/confirmation}FxEuropeanExercise"/>
               <element name="trigger" type="{http://www.fpml.org/FpML-5/confirmation}FxTrigger" maxOccurs="unbounded"/>
             </sequence>
           </choice>
           <element name="exerciseProcedure" type="{http://www.fpml.org/FpML-5/confirmation}ExerciseProcedure" minOccurs="0"/>
         </sequence>
         <element name="payout" type="{http://www.fpml.org/FpML-5/confirmation}FxOptionPayout"/>
         <element name="premium" type="{http://www.fpml.org/FpML-5/confirmation}FxOptionPremium" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field	Description
protected FxDigitalAmericanExercise	americanExercise
protected AdjustableOrRelativeDate	effectiveDate
protected FxEuropeanExercise	europeanExercise
protected ExerciseProcedure	exerciseProcedure
protected FxOptionPayout	payout
protected List<FxOptionPremium>	premium
protected Period	tenorPeriod
protected List<FxTouch>	touch
protected List<FxTrigger>	trigger

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

buyerAccountReference, buyerPartyReference, sellerAccountReference, sellerPartyReference

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

assetClass, id, primaryAssetClass, productId, productType, secondaryAssetClass

Constructor Summary

Constructors

Constructor	Description
FxDigitalOption()

Method Summary

Modifier and Type	Method	Description
FxDigitalAmericanExercise	getAmericanExercise()	Gets the value of the americanExercise property.
AdjustableOrRelativeDate	getEffectiveDate()	Gets the value of the effectiveDate property.
FxEuropeanExercise	getEuropeanExercise()	Gets the value of the europeanExercise property.
ExerciseProcedure	getExerciseProcedure()	Gets the value of the exerciseProcedure property.
FxOptionPayout	getPayout()	Gets the value of the payout property.
List<FxOptionPremium>	getPremium()	Gets the value of the premium property.
Period	getTenorPeriod()	Gets the value of the tenorPeriod property.
List<FxTouch>	getTouch()	Gets the value of the touch property.
List<FxTrigger>	getTrigger()	Gets the value of the trigger property.
void	setAmericanExercise(FxDigitalAmericanExercise value)	Sets the value of the americanExercise property.
void	setEffectiveDate(AdjustableOrRelativeDate value)	Sets the value of the effectiveDate property.
void	setEuropeanExercise(FxEuropeanExercise value)	Sets the value of the europeanExercise property.
void	setExerciseProcedure(ExerciseProcedure value)	Sets the value of the exerciseProcedure property.
void	setPayout(FxOptionPayout value)	Sets the value of the payout property.
void	setTenorPeriod(Period value)	Sets the value of the tenorPeriod property.

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

getBuyerAccountReference, getBuyerPartyReference, getSellerAccountReference, getSellerPartyReference, setBuyerAccountReference, setBuyerPartyReference, setSellerAccountReference, setSellerPartyReference

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

effectiveDate

protected AdjustableOrRelativeDate effectiveDate

tenorPeriod

protected Period tenorPeriod

americanExercise

protected FxDigitalAmericanExercise americanExercise

touch

protected List<FxTouch> touch

europeanExercise

protected FxEuropeanExercise europeanExercise

trigger

protected List<FxTrigger> trigger

exerciseProcedure

protected ExerciseProcedure exerciseProcedure

payout

protected FxOptionPayout payout

premium

protected List<FxOptionPremium> premium

Constructor Details

FxDigitalOption

public FxDigitalOption()

Method Details

getEffectiveDate

public AdjustableOrRelativeDate getEffectiveDate()

Gets the value of the effectiveDate property.

Returns:

possible object is AdjustableOrRelativeDate

setEffectiveDate

public void setEffectiveDate(AdjustableOrRelativeDate value)

Sets the value of the effectiveDate property.

Parameters:

value - allowed object is AdjustableOrRelativeDate

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

getAmericanExercise

public FxDigitalAmericanExercise getAmericanExercise()

Gets the value of the americanExercise property.

Returns:

possible object is FxDigitalAmericanExercise

setAmericanExercise

public void setAmericanExercise(FxDigitalAmericanExercise value)

Sets the value of the americanExercise property.

Parameters:

value - allowed object is FxDigitalAmericanExercise

getTouch

public List<FxTouch> getTouch()

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

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

    getTouch().add(newItem);
 

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

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

getTrigger

public List<FxTrigger> getTrigger()

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

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

    getTrigger().add(newItem);
 

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

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

getPayout

public FxOptionPayout getPayout()

Gets the value of the payout property.

Returns:

possible object is FxOptionPayout

setPayout

public void setPayout(FxOptionPayout value)

Sets the value of the payout property.

Parameters:

value - allowed object is FxOptionPayout

getPremium

public List<FxOptionPremium> 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 FxOptionPremium