Package net.finmath.smartcontract.product.xml

Class EquityOptionTransactionSupplement

java.lang.Object

net.finmath.smartcontract.product.xml.Product

net.finmath.smartcontract.product.xml.EquityDerivativeBase

net.finmath.smartcontract.product.xml.EquityDerivativeShortFormBase

net.finmath.smartcontract.product.xml.EquityOptionTransactionSupplement

public class EquityOptionTransactionSupplement
extends EquityDerivativeShortFormBase

A type for defining equity option transaction supplements.

Java class for EquityOptionTransactionSupplement complex type.

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

 <complexType name="EquityOptionTransactionSupplement">
   <complexContent>
     <extension base="{http://www.fpml.org/FpML-5/confirmation}EquityDerivativeShortFormBase">
       <sequence>
         <element name="exchangeLookAlike" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="exchangeTradedContractNearest" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <group ref="{http://www.fpml.org/FpML-5/confirmation}IndexAnnexFallback.model" minOccurs="0"/>
         <element name="methodOfAdjustment" type="{http://www.fpml.org/FpML-5/confirmation}MethodOfAdjustmentEnum" minOccurs="0"/>
         <element name="localJurisdiction" type="{http://www.fpml.org/FpML-5/confirmation}CountryCode" 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="extraordinaryEvents" type="{http://www.fpml.org/FpML-5/confirmation}ExtraordinaryEvents" minOccurs="0"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field	Description
protected Boolean	componentSecurityIndexAnnexFallback
protected Boolean	exchangeLookAlike
protected Boolean	exchangeTradedContractNearest
protected ExtraordinaryEvents	extraordinaryEvents
protected CountryCode	localJurisdiction
protected MethodOfAdjustmentEnum	methodOfAdjustment
protected Boolean	multipleExchangeIndexAnnexFallback
protected BigDecimal	multiplier
protected BigDecimal	optionEntitlement

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

equityPremium, numberOfOptions, spotPrice, strike

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

buyerAccountReference, buyerPartyReference, equityEffectiveDate, equityExercise, feature, fxFeature, notional, optionType, sellerAccountReference, sellerPartyReference, strategyFeature, underlyer

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

assetClass, id, primaryAssetClass, productId, productType, secondaryAssetClass

Constructor Summary

Constructors

Constructor	Description
EquityOptionTransactionSupplement()

Method Summary

Modifier and Type	Method	Description
ExtraordinaryEvents	getExtraordinaryEvents()	Gets the value of the extraordinaryEvents property.
CountryCode	getLocalJurisdiction()	Gets the value of the localJurisdiction 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	isComponentSecurityIndexAnnexFallback()	Gets the value of the componentSecurityIndexAnnexFallback property.
Boolean	isExchangeLookAlike()	Gets the value of the exchangeLookAlike property.
Boolean	isExchangeTradedContractNearest()	Gets the value of the exchangeTradedContractNearest property.
Boolean	isMultipleExchangeIndexAnnexFallback()	Gets the value of the multipleExchangeIndexAnnexFallback property.
void	setComponentSecurityIndexAnnexFallback(Boolean value)	Sets the value of the componentSecurityIndexAnnexFallback property.
void	setExchangeLookAlike(Boolean value)	Sets the value of the exchangeLookAlike property.
void	setExchangeTradedContractNearest(Boolean value)	Sets the value of the exchangeTradedContractNearest property.
void	setExtraordinaryEvents(ExtraordinaryEvents value)	Sets the value of the extraordinaryEvents property.
void	setLocalJurisdiction(CountryCode value)	Sets the value of the localJurisdiction property.
void	setMethodOfAdjustment(MethodOfAdjustmentEnum value)	Sets the value of the methodOfAdjustment property.
void	setMultipleExchangeIndexAnnexFallback(Boolean value)	Sets the value of the multipleExchangeIndexAnnexFallback 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.EquityDerivativeShortFormBase

getEquityPremium, getNumberOfOptions, getSpotPrice, getStrike, setEquityPremium, setNumberOfOptions, setSpotPrice, setStrike

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

getBuyerAccountReference, getBuyerPartyReference, getEquityEffectiveDate, getEquityExercise, getFeature, getFxFeature, getNotional, getOptionType, getSellerAccountReference, getSellerPartyReference, getStrategyFeature, getUnderlyer, setBuyerAccountReference, setBuyerPartyReference, setEquityEffectiveDate, setEquityExercise, setFeature, setFxFeature, setNotional, setOptionType, setSellerAccountReference, setSellerPartyReference, setStrategyFeature, setUnderlyer

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

exchangeLookAlike

protected Boolean exchangeLookAlike

exchangeTradedContractNearest

protected Boolean exchangeTradedContractNearest

multipleExchangeIndexAnnexFallback

protected Boolean multipleExchangeIndexAnnexFallback

componentSecurityIndexAnnexFallback

protected Boolean componentSecurityIndexAnnexFallback

methodOfAdjustment

protected MethodOfAdjustmentEnum methodOfAdjustment

localJurisdiction

protected CountryCode localJurisdiction

optionEntitlement

protected BigDecimal optionEntitlement

multiplier

protected BigDecimal multiplier

extraordinaryEvents

protected ExtraordinaryEvents extraordinaryEvents

Constructor Details

EquityOptionTransactionSupplement

public EquityOptionTransactionSupplement()

Method Details

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

isExchangeTradedContractNearest

public Boolean isExchangeTradedContractNearest()

Gets the value of the exchangeTradedContractNearest property.

Returns:

possible object is Boolean

setExchangeTradedContractNearest

public void setExchangeTradedContractNearest(Boolean value)

Sets the value of the exchangeTradedContractNearest property.

Parameters:

value - allowed object is Boolean

isMultipleExchangeIndexAnnexFallback

public Boolean isMultipleExchangeIndexAnnexFallback()

Gets the value of the multipleExchangeIndexAnnexFallback property.

Returns:

possible object is Boolean

setMultipleExchangeIndexAnnexFallback

public void setMultipleExchangeIndexAnnexFallback(Boolean value)

Sets the value of the multipleExchangeIndexAnnexFallback property.

Parameters:

value - allowed object is Boolean

isComponentSecurityIndexAnnexFallback

public Boolean isComponentSecurityIndexAnnexFallback()

Gets the value of the componentSecurityIndexAnnexFallback property.

Returns:

possible object is Boolean

setComponentSecurityIndexAnnexFallback

public void setComponentSecurityIndexAnnexFallback(Boolean value)

Sets the value of the componentSecurityIndexAnnexFallback 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

getLocalJurisdiction

public CountryCode getLocalJurisdiction()

Gets the value of the localJurisdiction property.

Returns:

possible object is CountryCode

setLocalJurisdiction

public void setLocalJurisdiction(CountryCode value)

Sets the value of the localJurisdiction property.

Parameters:

value - allowed object is CountryCode

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

getExtraordinaryEvents

public ExtraordinaryEvents getExtraordinaryEvents()

Gets the value of the extraordinaryEvents property.

Returns:

possible object is ExtraordinaryEvents

setExtraordinaryEvents

public void setExtraordinaryEvents(ExtraordinaryEvents value)

Sets the value of the extraordinaryEvents property.

Parameters:

value - allowed object is ExtraordinaryEvents