Package net.finmath.smartcontract.product.xml

Class DividendSwapOptionTransactionSupplement

java.lang.Object

net.finmath.smartcontract.product.xml.Product

net.finmath.smartcontract.product.xml.Option

net.finmath.smartcontract.product.xml.OptionBase

net.finmath.smartcontract.product.xml.DividendSwapOptionTransactionSupplement

public class DividendSwapOptionTransactionSupplement
extends OptionBase

Java class for DividendSwapOptionTransactionSupplement complex type.

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

 <complexType name="DividendSwapOptionTransactionSupplement">
   <complexContent>
     <extension base="{http://www.fpml.org/FpML-5/confirmation}OptionBase">
       <sequence>
         <element name="equityPremium" type="{http://www.fpml.org/FpML-5/confirmation}EquityPremium"/>
         <element name="equityExercise" type="{http://www.fpml.org/FpML-5/confirmation}EquityExerciseValuationSettlement"/>
         <element name="exchangeLookAlike" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="methodOfAdjustment" type="{http://www.fpml.org/FpML-5/confirmation}MethodOfAdjustmentEnum" minOccurs="0"/>
         <choice minOccurs="0">
           <element name="optionEntitlement" type="{http://www.fpml.org/FpML-5/confirmation}PositiveDecimal"/>
           <element name="multiplier" type="{http://www.fpml.org/FpML-5/confirmation}PositiveDecimal"/>
         </choice>
         <element name="clearingInstructions" type="{http://www.fpml.org/FpML-5/confirmation}SwaptionPhysicalSettlement" minOccurs="0"/>
         <element name="dividendSwapTransactionSupplement" type="{http://www.fpml.org/FpML-5/confirmation}DividendSwapTransactionSupplement"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field	Description
protected SwaptionPhysicalSettlement	clearingInstructions
protected DividendSwapTransactionSupplement	dividendSwapTransactionSupplement
protected EquityExerciseValuationSettlement	equityExercise
protected EquityPremium	equityPremium
protected Boolean	exchangeLookAlike
protected MethodOfAdjustmentEnum	methodOfAdjustment
protected BigDecimal	multiplier
protected BigDecimal	optionEntitlement

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

optionType

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
DividendSwapOptionTransactionSupplement()

Method Summary

Modifier and Type	Method	Description
SwaptionPhysicalSettlement	getClearingInstructions()	Gets the value of the clearingInstructions property.
DividendSwapTransactionSupplement	getDividendSwapTransactionSupplement()	Gets the value of the dividendSwapTransactionSupplement property.
EquityExerciseValuationSettlement	getEquityExercise()	Gets the value of the equityExercise property.
EquityPremium	getEquityPremium()	Gets the value of the equityPremium property.
MethodOfAdjustmentEnum	getMethodOfAdjustment()	Gets the value of the methodOfAdjustment property.
BigDecimal	getMultiplier()	Gets the value of the multiplier property.
BigDecimal	getOptionEntitlement()	Gets the value of the optionEntitlement property.
Boolean	isExchangeLookAlike()	Gets the value of the exchangeLookAlike property.
void	setClearingInstructions(SwaptionPhysicalSettlement value)	Sets the value of the clearingInstructions property.
void	setDividendSwapTransactionSupplement(DividendSwapTransactionSupplement value)	Sets the value of the dividendSwapTransactionSupplement property.
void	setEquityExercise(EquityExerciseValuationSettlement value)	Sets the value of the equityExercise property.
void	setEquityPremium(EquityPremium value)	Sets the value of the equityPremium property.
void	setExchangeLookAlike(Boolean value)	Sets the value of the exchangeLookAlike property.
void	setMethodOfAdjustment(MethodOfAdjustmentEnum value)	Sets the value of the methodOfAdjustment property.
void	setMultiplier(BigDecimal value)	Sets the value of the multiplier property.
void	setOptionEntitlement(BigDecimal value)	Sets the value of the optionEntitlement property.

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

getOptionType, setOptionType

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

equityPremium

protected EquityPremium equityPremium

equityExercise

protected EquityExerciseValuationSettlement equityExercise

exchangeLookAlike

protected Boolean exchangeLookAlike

methodOfAdjustment

protected MethodOfAdjustmentEnum methodOfAdjustment

optionEntitlement

protected BigDecimal optionEntitlement

multiplier

protected BigDecimal multiplier

clearingInstructions

protected SwaptionPhysicalSettlement clearingInstructions

dividendSwapTransactionSupplement

protected DividendSwapTransactionSupplement dividendSwapTransactionSupplement

Constructor Details

DividendSwapOptionTransactionSupplement

public DividendSwapOptionTransactionSupplement()

Method Details

getEquityPremium

public EquityPremium getEquityPremium()

Gets the value of the equityPremium property.

Returns:

possible object is EquityPremium

setEquityPremium

public void setEquityPremium(EquityPremium value)

Sets the value of the equityPremium property.

Parameters:

value - allowed object is EquityPremium

getEquityExercise

public EquityExerciseValuationSettlement getEquityExercise()

Gets the value of the equityExercise property.

Returns:

possible object is EquityExerciseValuationSettlement

setEquityExercise

public void setEquityExercise(EquityExerciseValuationSettlement value)

Sets the value of the equityExercise property.

Parameters:

value - allowed object is EquityExerciseValuationSettlement

isExchangeLookAlike

public Boolean isExchangeLookAlike()

Gets the value of the exchangeLookAlike property.

Returns:

possible object is Boolean

setExchangeLookAlike

public void setExchangeLookAlike(Boolean value)

Sets the value of the exchangeLookAlike property.

Parameters:

value - allowed object is Boolean

getMethodOfAdjustment

public MethodOfAdjustmentEnum getMethodOfAdjustment()

Gets the value of the methodOfAdjustment property.

Returns:

possible object is MethodOfAdjustmentEnum

setMethodOfAdjustment

public void setMethodOfAdjustment(MethodOfAdjustmentEnum value)

Sets the value of the methodOfAdjustment property.

Parameters:

value - allowed object is MethodOfAdjustmentEnum

getOptionEntitlement

public BigDecimal getOptionEntitlement()

Gets the value of the optionEntitlement property.

Returns:

possible object is BigDecimal

setOptionEntitlement

public void setOptionEntitlement(BigDecimal value)

Sets the value of the optionEntitlement property.

Parameters:

value - allowed object is BigDecimal

getMultiplier

public BigDecimal getMultiplier()

Gets the value of the multiplier property.

Returns:

possible object is BigDecimal

setMultiplier

public void setMultiplier(BigDecimal value)

Sets the value of the multiplier property.

Parameters:

value - allowed object is BigDecimal

getClearingInstructions

public SwaptionPhysicalSettlement getClearingInstructions()

Gets the value of the clearingInstructions property.

Returns:

possible object is SwaptionPhysicalSettlement

setClearingInstructions

public void setClearingInstructions(SwaptionPhysicalSettlement value)

Sets the value of the clearingInstructions property.

Parameters:

value - allowed object is SwaptionPhysicalSettlement

getDividendSwapTransactionSupplement

public DividendSwapTransactionSupplement getDividendSwapTransactionSupplement()

Gets the value of the dividendSwapTransactionSupplement property.

Returns:

possible object is DividendSwapTransactionSupplement

setDividendSwapTransactionSupplement

public void setDividendSwapTransactionSupplement(DividendSwapTransactionSupplement value)

Sets the value of the dividendSwapTransactionSupplement property.

Parameters:

value - allowed object is DividendSwapTransactionSupplement