Package net.finmath.smartcontract.product.xml

Class FxOptionPayout

java.lang.Object

net.finmath.smartcontract.product.xml.MoneyBase

net.finmath.smartcontract.product.xml.NonNegativeMoney

net.finmath.smartcontract.product.xml.FxOptionPayout

public class FxOptionPayout
extends NonNegativeMoney

A type that contains full details of a predefined fixed payout which may occur (or not) in a Barrier Option or Digital Option when a trigger event occurs (or not).

Java class for FxOptionPayout complex type.

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

 <complexType name="FxOptionPayout">
   <complexContent>
     <extension base="{http://www.fpml.org/FpML-5/confirmation}NonNegativeMoney">
       <sequence>
         <element name="payoutStyle" type="{http://www.fpml.org/FpML-5/confirmation}PayoutEnum"/>
         <element name="settlementInformation" type="{http://www.fpml.org/FpML-5/confirmation}SettlementInformation" minOccurs="0"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field	Description
protected PayoutEnum	payoutStyle
protected SettlementInformation	settlementInformation

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

amount

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

currency, id

Constructor Summary

Constructors

Constructor	Description
FxOptionPayout()

Method Summary

Modifier and Type	Method	Description
PayoutEnum	getPayoutStyle()	Gets the value of the payoutStyle property.
SettlementInformation	getSettlementInformation()	Gets the value of the settlementInformation property.
void	setPayoutStyle(PayoutEnum value)	Sets the value of the payoutStyle property.
void	setSettlementInformation(SettlementInformation value)	Sets the value of the settlementInformation property.

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

getAmount, setAmount

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

getCurrency, getId, setCurrency, setId

Methods inherited from class java.lang.Object

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

Field Details

payoutStyle

protected PayoutEnum payoutStyle

settlementInformation

protected SettlementInformation settlementInformation

Constructor Details

FxOptionPayout

public FxOptionPayout()

Method Details

getPayoutStyle

public PayoutEnum getPayoutStyle()

Gets the value of the payoutStyle property.

Returns:

possible object is PayoutEnum

setPayoutStyle

public void setPayoutStyle(PayoutEnum value)

Sets the value of the payoutStyle property.

Parameters:

value - allowed object is PayoutEnum

getSettlementInformation

public SettlementInformation getSettlementInformation()

Gets the value of the settlementInformation property.

Returns:

possible object is SettlementInformation

setSettlementInformation

public void setSettlementInformation(SettlementInformation value)

Sets the value of the settlementInformation property.

Parameters:

value - allowed object is SettlementInformation