Package net.finmath.smartcontract.product.xml

Class CommodityPhysicalAmericanExercise

java.lang.Object

net.finmath.smartcontract.product.xml.Exercise

net.finmath.smartcontract.product.xml.CommodityPhysicalAmericanExercise

public class CommodityPhysicalAmericanExercise
extends Exercise

The parameters for defining the expiration date(s) and time(s) for an American style option.

Java class for CommodityPhysicalAmericanExercise complex type.

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

 <complexType name="CommodityPhysicalAmericanExercise">
   <complexContent>
     <extension base="{http://www.fpml.org/FpML-5/confirmation}Exercise">
       <sequence>
         <choice>
           <sequence>
             <element name="commencementDates" type="{http://www.fpml.org/FpML-5/confirmation}AdjustableOrRelativeDates"/>
             <element name="expirationDates" type="{http://www.fpml.org/FpML-5/confirmation}AdjustableOrRelativeDates"/>
           </sequence>
           <sequence>
             <element name="relativeCommencementDates" type="{http://www.fpml.org/FpML-5/confirmation}CommodityRelativeExpirationDates"/>
             <element name="relativeExpirationDates" type="{http://www.fpml.org/FpML-5/confirmation}CommodityRelativeExpirationDates"/>
           </sequence>
         </choice>
         <element name="latestExerciseTime" type="{http://www.fpml.org/FpML-5/confirmation}PrevailingTime" minOccurs="0"/>
         <element name="expirationTime" type="{http://www.fpml.org/FpML-5/confirmation}PrevailingTime" minOccurs="0"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field	Description
protected AdjustableOrRelativeDates	commencementDates
protected AdjustableOrRelativeDates	expirationDates
protected PrevailingTime	expirationTime
protected PrevailingTime	latestExerciseTime
protected CommodityRelativeExpirationDates	relativeCommencementDates
protected CommodityRelativeExpirationDates	relativeExpirationDates

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

id

Constructor Summary

Constructors

Constructor	Description
CommodityPhysicalAmericanExercise()

Method Summary

Modifier and Type	Method	Description
AdjustableOrRelativeDates	getCommencementDates()	Gets the value of the commencementDates property.
AdjustableOrRelativeDates	getExpirationDates()	Gets the value of the expirationDates property.
PrevailingTime	getExpirationTime()	Gets the value of the expirationTime property.
PrevailingTime	getLatestExerciseTime()	Gets the value of the latestExerciseTime property.
CommodityRelativeExpirationDates	getRelativeCommencementDates()	Gets the value of the relativeCommencementDates property.
CommodityRelativeExpirationDates	getRelativeExpirationDates()	Gets the value of the relativeExpirationDates property.
void	setCommencementDates(AdjustableOrRelativeDates value)	Sets the value of the commencementDates property.
void	setExpirationDates(AdjustableOrRelativeDates value)	Sets the value of the expirationDates property.
void	setExpirationTime(PrevailingTime value)	Sets the value of the expirationTime property.
void	setLatestExerciseTime(PrevailingTime value)	Sets the value of the latestExerciseTime property.
void	setRelativeCommencementDates(CommodityRelativeExpirationDates value)	Sets the value of the relativeCommencementDates property.
void	setRelativeExpirationDates(CommodityRelativeExpirationDates value)	Sets the value of the relativeExpirationDates property.

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

commencementDates

protected AdjustableOrRelativeDates commencementDates

expirationDates

protected AdjustableOrRelativeDates expirationDates

relativeCommencementDates

protected CommodityRelativeExpirationDates relativeCommencementDates

relativeExpirationDates

protected CommodityRelativeExpirationDates relativeExpirationDates

latestExerciseTime

protected PrevailingTime latestExerciseTime

expirationTime

protected PrevailingTime expirationTime

Constructor Details

CommodityPhysicalAmericanExercise

public CommodityPhysicalAmericanExercise()

Method Details

getCommencementDates

public AdjustableOrRelativeDates getCommencementDates()

Gets the value of the commencementDates property.

Returns:

possible object is AdjustableOrRelativeDates

setCommencementDates

public void setCommencementDates(AdjustableOrRelativeDates value)

Sets the value of the commencementDates property.

Parameters:

value - allowed object is AdjustableOrRelativeDates

getExpirationDates

public AdjustableOrRelativeDates getExpirationDates()

Gets the value of the expirationDates property.

Returns:

possible object is AdjustableOrRelativeDates

setExpirationDates

public void setExpirationDates(AdjustableOrRelativeDates value)

Sets the value of the expirationDates property.

Parameters:

value - allowed object is AdjustableOrRelativeDates

getRelativeCommencementDates

public CommodityRelativeExpirationDates getRelativeCommencementDates()

Gets the value of the relativeCommencementDates property.

Returns:

possible object is CommodityRelativeExpirationDates

setRelativeCommencementDates

public void setRelativeCommencementDates(CommodityRelativeExpirationDates value)

Sets the value of the relativeCommencementDates property.

Parameters:

value - allowed object is CommodityRelativeExpirationDates

getRelativeExpirationDates

public CommodityRelativeExpirationDates getRelativeExpirationDates()

Gets the value of the relativeExpirationDates property.

Returns:

possible object is CommodityRelativeExpirationDates

setRelativeExpirationDates

public void setRelativeExpirationDates(CommodityRelativeExpirationDates value)

Sets the value of the relativeExpirationDates property.

Parameters:

value - allowed object is CommodityRelativeExpirationDates

getLatestExerciseTime

public PrevailingTime getLatestExerciseTime()

Gets the value of the latestExerciseTime property.

Returns:

possible object is PrevailingTime

setLatestExerciseTime

public void setLatestExerciseTime(PrevailingTime value)

Sets the value of the latestExerciseTime property.

Parameters:

value - allowed object is PrevailingTime

getExpirationTime

public PrevailingTime getExpirationTime()

Gets the value of the expirationTime property.

Returns:

possible object is PrevailingTime

setExpirationTime

public void setExpirationTime(PrevailingTime value)

Sets the value of the expirationTime property.

Parameters:

value - allowed object is PrevailingTime