Package net.finmath.smartcontract.product.xml

Class OptionExpiry

java.lang.Object

net.finmath.smartcontract.product.xml.AbstractEvent

net.finmath.smartcontract.product.xml.OptionExpiry

public class OptionExpiry
extends AbstractEvent

A structure describing an option expiring (i.e. passing its last exercise time and becoming worthless.)

Java class for OptionExpiry complex type.

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

 <complexType name="OptionExpiry">
   <complexContent>
     <extension base="{http://www.fpml.org/FpML-5/confirmation}AbstractEvent">
       <sequence>
         <choice>
           <element name="originalTrade" type="{http://www.fpml.org/FpML-5/confirmation}Trade"/>
           <element name="tradeIdentifier" type="{http://www.fpml.org/FpML-5/confirmation}PartyTradeIdentifier" maxOccurs="unbounded"/>
         </choice>
         <element name="date" type="{http://www.w3.org/2001/XMLSchema}date"/>
         <element name="time" type="{http://www.w3.org/2001/XMLSchema}time"/>
         <element name="exerciseProcedure" type="{http://www.fpml.org/FpML-5/confirmation}ExerciseProcedureOption" minOccurs="0"/>
         <element name="actionOnExpiration" type="{http://www.fpml.org/FpML-5/confirmation}ActionOnExpiration" minOccurs="0"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field	Description
protected ActionOnExpiration	actionOnExpiration
protected XMLGregorianCalendar	date
protected ExerciseProcedureOption	exerciseProcedure
protected Trade	originalTrade
protected XMLGregorianCalendar	time
protected List<PartyTradeIdentifier>	tradeIdentifier

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

eventIdentifier

Constructor Summary

Constructors

Constructor	Description
OptionExpiry()

Method Summary

Modifier and Type	Method	Description
ActionOnExpiration	getActionOnExpiration()	Gets the value of the actionOnExpiration property.
XMLGregorianCalendar	getDate()	Gets the value of the date property.
ExerciseProcedureOption	getExerciseProcedure()	Gets the value of the exerciseProcedure property.
Trade	getOriginalTrade()	Gets the value of the originalTrade property.
XMLGregorianCalendar	getTime()	Gets the value of the time property.
List<PartyTradeIdentifier>	getTradeIdentifier()	Gets the value of the tradeIdentifier property.
void	setActionOnExpiration(ActionOnExpiration value)	Sets the value of the actionOnExpiration property.
void	setDate(XMLGregorianCalendar value)	Sets the value of the date property.
void	setExerciseProcedure(ExerciseProcedureOption value)	Sets the value of the exerciseProcedure property.
void	setOriginalTrade(Trade value)	Sets the value of the originalTrade property.
void	setTime(XMLGregorianCalendar value)	Sets the value of the time property.

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

getEventIdentifier

Methods inherited from class java.lang.Object

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

Field Details

originalTrade

protected Trade originalTrade

tradeIdentifier

protected List<PartyTradeIdentifier> tradeIdentifier

date

protected XMLGregorianCalendar date

time

protected XMLGregorianCalendar time

exerciseProcedure

protected ExerciseProcedureOption exerciseProcedure

actionOnExpiration

protected ActionOnExpiration actionOnExpiration

Constructor Details

OptionExpiry

public OptionExpiry()

Method Details

getOriginalTrade

public Trade getOriginalTrade()

Gets the value of the originalTrade property.

Returns:

possible object is Trade

setOriginalTrade

public void setOriginalTrade(Trade value)

Sets the value of the originalTrade property.

Parameters:

value - allowed object is Trade

getTradeIdentifier

public List<PartyTradeIdentifier> getTradeIdentifier()

Gets the value of the tradeIdentifier property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the Jakarta XML Binding object. This is why there is not a set method for the tradeIdentifier property.

For example, to add a new item, do as follows:

    getTradeIdentifier().add(newItem);
 

Objects of the following type(s) are allowed in the list PartyTradeIdentifier

getDate

public XMLGregorianCalendar getDate()

Gets the value of the date property.

Returns:

possible object is XMLGregorianCalendar

setDate

public void setDate(XMLGregorianCalendar value)

Sets the value of the date property.

Parameters:

value - allowed object is XMLGregorianCalendar

getTime

public XMLGregorianCalendar getTime()

Gets the value of the time property.

Returns:

possible object is XMLGregorianCalendar

setTime

public void setTime(XMLGregorianCalendar value)

Sets the value of the time property.

Parameters:

value - allowed object is XMLGregorianCalendar

getExerciseProcedure

public ExerciseProcedureOption getExerciseProcedure()

Gets the value of the exerciseProcedure property.

Returns:

possible object is ExerciseProcedureOption

setExerciseProcedure

public void setExerciseProcedure(ExerciseProcedureOption value)

Sets the value of the exerciseProcedure property.

Parameters:

value - allowed object is ExerciseProcedureOption

getActionOnExpiration

public ActionOnExpiration getActionOnExpiration()

Gets the value of the actionOnExpiration property.

Returns:

possible object is ActionOnExpiration

setActionOnExpiration

public void setActionOnExpiration(ActionOnExpiration value)

Sets the value of the actionOnExpiration property.

Parameters:

value - allowed object is ActionOnExpiration