Package net.finmath.smartcontract.product.xml

Class EquityOption

java.lang.Object

net.finmath.smartcontract.product.xml.Product

net.finmath.smartcontract.product.xml.EquityDerivativeBase

net.finmath.smartcontract.product.xml.EquityDerivativeLongFormBase

net.finmath.smartcontract.product.xml.EquityOption

public class EquityOption
extends EquityDerivativeLongFormBase

A type for defining equity options.

Java class for EquityOption complex type.

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

 <complexType name="EquityOption">
   <complexContent>
     <extension base="{http://www.fpml.org/FpML-5/confirmation}EquityDerivativeLongFormBase">
       <sequence>
         <element name="strike" type="{http://www.fpml.org/FpML-5/confirmation}EquityStrike" minOccurs="0"/>
         <element name="spotPrice" type="{http://www.fpml.org/FpML-5/confirmation}NonNegativeDecimal" minOccurs="0"/>
         <element name="numberOfOptions" type="{http://www.fpml.org/FpML-5/confirmation}NonNegativeDecimal" minOccurs="0"/>
         <element name="optionEntitlement" type="{http://www.fpml.org/FpML-5/confirmation}PositiveDecimal"/>
         <element name="equityPremium" type="{http://www.fpml.org/FpML-5/confirmation}EquityPremium"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field	Description
protected EquityPremium	equityPremium
protected BigDecimal	numberOfOptions
protected BigDecimal	optionEntitlement
protected BigDecimal	spotPrice
protected EquityStrike	strike

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

dividendConditions, extraordinaryEvents, methodOfAdjustment

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

Method Summary

Modifier and Type	Method	Description
EquityPremium	getEquityPremium()	Gets the value of the equityPremium property.
BigDecimal	getNumberOfOptions()	Gets the value of the numberOfOptions property.
BigDecimal	getOptionEntitlement()	Gets the value of the optionEntitlement property.
BigDecimal	getSpotPrice()	Gets the value of the spotPrice property.
EquityStrike	getStrike()	Gets the value of the strike property.
void	setEquityPremium(EquityPremium value)	Sets the value of the equityPremium property.
void	setNumberOfOptions(BigDecimal value)	Sets the value of the numberOfOptions property.
void	setOptionEntitlement(BigDecimal value)	Sets the value of the optionEntitlement property.
void	setSpotPrice(BigDecimal value)	Sets the value of the spotPrice property.
void	setStrike(EquityStrike value)	Sets the value of the strike property.

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

getDividendConditions, getExtraordinaryEvents, getMethodOfAdjustment, setDividendConditions, setExtraordinaryEvents, setMethodOfAdjustment

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

strike

protected EquityStrike strike

spotPrice

protected BigDecimal spotPrice

numberOfOptions

protected BigDecimal numberOfOptions

optionEntitlement

protected BigDecimal optionEntitlement

equityPremium

protected EquityPremium equityPremium

Constructor Details

EquityOption

public EquityOption()

Method Details

getStrike

public EquityStrike getStrike()

Gets the value of the strike property.

Returns:

possible object is EquityStrike

setStrike

public void setStrike(EquityStrike value)

Sets the value of the strike property.

Parameters:

value - allowed object is EquityStrike

getSpotPrice

public BigDecimal getSpotPrice()

Gets the value of the spotPrice property.

Returns:

possible object is BigDecimal

setSpotPrice

public void setSpotPrice(BigDecimal value)

Sets the value of the spotPrice property.

Parameters:

value - allowed object is BigDecimal

getNumberOfOptions

public BigDecimal getNumberOfOptions()

Gets the value of the numberOfOptions property.

Returns:

possible object is BigDecimal

setNumberOfOptions

public void setNumberOfOptions(BigDecimal value)

Sets the value of the numberOfOptions property.

Parameters:

value - allowed object is BigDecimal

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

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