Package net.finmath.smartcontract.product.xml

Class EquityAmericanExercise

java.lang.Object

net.finmath.smartcontract.product.xml.Exercise

net.finmath.smartcontract.product.xml.SharedAmericanExercise

net.finmath.smartcontract.product.xml.EquityAmericanExercise

public class EquityAmericanExercise
extends SharedAmericanExercise

A type for defining exercise procedures associated with an American style exercise of an equity option. This entity inherits from the type SharedAmericanExercise.

Java class for EquityAmericanExercise complex type.

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

 <complexType name="EquityAmericanExercise">
   <complexContent>
     <extension base="{http://www.fpml.org/FpML-5/confirmation}SharedAmericanExercise">
       <sequence>
         <element name="latestExerciseTimeType" type="{http://www.fpml.org/FpML-5/confirmation}TimeTypeEnum" minOccurs="0"/>
         <group ref="{http://www.fpml.org/FpML-5/confirmation}EquityExpiration.model"/>
         <element name="equityMultipleExercise" type="{http://www.fpml.org/FpML-5/confirmation}EquityMultipleExercise" minOccurs="0"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field	Description
protected BusinessCenterTime	equityExpirationTime
protected TimeTypeEnum	equityExpirationTimeType
protected EquityMultipleExercise	equityMultipleExercise
protected DeterminationMethod	expirationTimeDetermination
protected TimeTypeEnum	latestExerciseTimeType

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

commencementDate, expirationDate, latestExerciseTime, latestExerciseTimeDetermination

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

id

Constructor Summary

Constructors

Constructor	Description
EquityAmericanExercise()

Method Summary

Modifier and Type	Method	Description
BusinessCenterTime	getEquityExpirationTime()	Gets the value of the equityExpirationTime property.
TimeTypeEnum	getEquityExpirationTimeType()	Gets the value of the equityExpirationTimeType property.
EquityMultipleExercise	getEquityMultipleExercise()	Gets the value of the equityMultipleExercise property.
DeterminationMethod	getExpirationTimeDetermination()	Gets the value of the expirationTimeDetermination property.
TimeTypeEnum	getLatestExerciseTimeType()	Gets the value of the latestExerciseTimeType property.
void	setEquityExpirationTime(BusinessCenterTime value)	Sets the value of the equityExpirationTime property.
void	setEquityExpirationTimeType(TimeTypeEnum value)	Sets the value of the equityExpirationTimeType property.
void	setEquityMultipleExercise(EquityMultipleExercise value)	Sets the value of the equityMultipleExercise property.
void	setExpirationTimeDetermination(DeterminationMethod value)	Sets the value of the expirationTimeDetermination property.
void	setLatestExerciseTimeType(TimeTypeEnum value)	Sets the value of the latestExerciseTimeType property.

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

getCommencementDate, getExpirationDate, getLatestExerciseTime, getLatestExerciseTimeDetermination, setCommencementDate, setExpirationDate, setLatestExerciseTime, setLatestExerciseTimeDetermination

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

getId, setId

Methods inherited from class java.lang.Object

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

Field Details

latestExerciseTimeType

protected TimeTypeEnum latestExerciseTimeType

equityExpirationTimeType

protected TimeTypeEnum equityExpirationTimeType

equityExpirationTime

protected BusinessCenterTime equityExpirationTime

expirationTimeDetermination

protected DeterminationMethod expirationTimeDetermination

equityMultipleExercise

protected EquityMultipleExercise equityMultipleExercise

Constructor Details

EquityAmericanExercise

public EquityAmericanExercise()

Method Details

getLatestExerciseTimeType

public TimeTypeEnum getLatestExerciseTimeType()

Gets the value of the latestExerciseTimeType property.

Returns:

possible object is TimeTypeEnum

setLatestExerciseTimeType

public void setLatestExerciseTimeType(TimeTypeEnum value)

Sets the value of the latestExerciseTimeType property.

Parameters:

value - allowed object is TimeTypeEnum

getEquityExpirationTimeType

public TimeTypeEnum getEquityExpirationTimeType()

Gets the value of the equityExpirationTimeType property.

Returns:

possible object is TimeTypeEnum

setEquityExpirationTimeType

public void setEquityExpirationTimeType(TimeTypeEnum value)

Sets the value of the equityExpirationTimeType property.

Parameters:

value - allowed object is TimeTypeEnum

getEquityExpirationTime

public BusinessCenterTime getEquityExpirationTime()

Gets the value of the equityExpirationTime property.

Returns:

possible object is BusinessCenterTime

setEquityExpirationTime

public void setEquityExpirationTime(BusinessCenterTime value)

Sets the value of the equityExpirationTime property.

Parameters:

value - allowed object is BusinessCenterTime

getExpirationTimeDetermination

public DeterminationMethod getExpirationTimeDetermination()

Gets the value of the expirationTimeDetermination property.

Returns:

possible object is DeterminationMethod

setExpirationTimeDetermination

public void setExpirationTimeDetermination(DeterminationMethod value)

Sets the value of the expirationTimeDetermination property.

Parameters:

value - allowed object is DeterminationMethod

getEquityMultipleExercise

public EquityMultipleExercise getEquityMultipleExercise()

Gets the value of the equityMultipleExercise property.

Returns:

possible object is EquityMultipleExercise

setEquityMultipleExercise

public void setEquityMultipleExercise(EquityMultipleExercise value)

Sets the value of the equityMultipleExercise property.

Parameters:

value - allowed object is EquityMultipleExercise