Package net.finmath.smartcontract.product.xml

Class CommodityPhysicalExercise

java.lang.Object

net.finmath.smartcontract.product.xml.CommodityPhysicalExercise

public class CommodityPhysicalExercise
extends Object

The parameters for defining how the physically-settled commodity option can be exercised and how it is settled.

Java class for CommodityPhysicalExercise complex type.

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

 <complexType name="CommodityPhysicalExercise">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <choice>
           <element name="americanExercise" type="{http://www.fpml.org/FpML-5/confirmation}CommodityPhysicalAmericanExercise"/>
           <element name="europeanExercise" type="{http://www.fpml.org/FpML-5/confirmation}CommodityPhysicalEuropeanExercise"/>
         </choice>
         <element name="automaticExercise" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="writtenConfirmation" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="clearingInstructions" type="{http://www.fpml.org/FpML-5/confirmation}SwaptionPhysicalSettlement" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field	Description
protected CommodityPhysicalAmericanExercise	americanExercise
protected Boolean	automaticExercise
protected SwaptionPhysicalSettlement	clearingInstructions
protected CommodityPhysicalEuropeanExercise	europeanExercise
protected Boolean	writtenConfirmation

Constructor Summary

Constructors

Constructor	Description
CommodityPhysicalExercise()

Method Summary

Modifier and Type	Method	Description
CommodityPhysicalAmericanExercise	getAmericanExercise()	Gets the value of the americanExercise property.
SwaptionPhysicalSettlement	getClearingInstructions()	Gets the value of the clearingInstructions property.
CommodityPhysicalEuropeanExercise	getEuropeanExercise()	Gets the value of the europeanExercise property.
Boolean	isAutomaticExercise()	Gets the value of the automaticExercise property.
Boolean	isWrittenConfirmation()	Gets the value of the writtenConfirmation property.
void	setAmericanExercise(CommodityPhysicalAmericanExercise value)	Sets the value of the americanExercise property.
void	setAutomaticExercise(Boolean value)	Sets the value of the automaticExercise property.
void	setClearingInstructions(SwaptionPhysicalSettlement value)	Sets the value of the clearingInstructions property.
void	setEuropeanExercise(CommodityPhysicalEuropeanExercise value)	Sets the value of the europeanExercise property.
void	setWrittenConfirmation(Boolean value)	Sets the value of the writtenConfirmation property.

Methods inherited from class java.lang.Object

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

Field Details

americanExercise

protected CommodityPhysicalAmericanExercise americanExercise

europeanExercise

protected CommodityPhysicalEuropeanExercise europeanExercise

automaticExercise

protected Boolean automaticExercise

writtenConfirmation

protected Boolean writtenConfirmation

clearingInstructions

protected SwaptionPhysicalSettlement clearingInstructions

Constructor Details

CommodityPhysicalExercise

public CommodityPhysicalExercise()

Method Details

getAmericanExercise

public CommodityPhysicalAmericanExercise getAmericanExercise()

Gets the value of the americanExercise property.

Returns:

possible object is CommodityPhysicalAmericanExercise

setAmericanExercise

public void setAmericanExercise(CommodityPhysicalAmericanExercise value)

Sets the value of the americanExercise property.

Parameters:

value - allowed object is CommodityPhysicalAmericanExercise

getEuropeanExercise

public CommodityPhysicalEuropeanExercise getEuropeanExercise()

Gets the value of the europeanExercise property.

Returns:

possible object is CommodityPhysicalEuropeanExercise

setEuropeanExercise

public void setEuropeanExercise(CommodityPhysicalEuropeanExercise value)

Sets the value of the europeanExercise property.

Parameters:

value - allowed object is CommodityPhysicalEuropeanExercise

isAutomaticExercise

public Boolean isAutomaticExercise()

Gets the value of the automaticExercise property.

Returns:

possible object is Boolean

setAutomaticExercise

public void setAutomaticExercise(Boolean value)

Sets the value of the automaticExercise property.

Parameters:

value - allowed object is Boolean

isWrittenConfirmation

public Boolean isWrittenConfirmation()

Gets the value of the writtenConfirmation property.

Returns:

possible object is Boolean

setWrittenConfirmation

public void setWrittenConfirmation(Boolean value)

Sets the value of the writtenConfirmation property.

Parameters:

value - allowed object is Boolean

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