Package net.finmath.smartcontract.product.xml

Class CommodityBarrier

java.lang.Object

net.finmath.smartcontract.product.xml.CommodityBarrier

public class CommodityBarrier
extends Object

The specification of how a barrier option will trigger (that is, knock-in or knock-out) or expire based on the position of the spot rate relative to trigger level.

Java class for CommodityBarrier complex type.

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

 <complexType name="CommodityBarrier">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <sequence>
           <element name="knock" type="{http://www.fpml.org/FpML-5/confirmation}CommodityKnockEnum"/>
           <element name="featurePaymentAmount" type="{http://www.fpml.org/FpML-5/confirmation}PositiveMoney" minOccurs="0"/>
         </sequence>
         <element name="trigger" type="{http://www.fpml.org/FpML-5/confirmation}CommodityTrigger"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field	Description
protected PositiveMoney	featurePaymentAmount
protected CommodityKnockEnum	knock
protected CommodityTrigger	trigger

Constructor Summary

Constructors

Constructor	Description
CommodityBarrier()

Method Summary

Modifier and Type	Method	Description
PositiveMoney	getFeaturePaymentAmount()	Gets the value of the featurePaymentAmount property.
CommodityKnockEnum	getKnock()	Gets the value of the knock property.
CommodityTrigger	getTrigger()	Gets the value of the trigger property.
void	setFeaturePaymentAmount(PositiveMoney value)	Sets the value of the featurePaymentAmount property.
void	setKnock(CommodityKnockEnum value)	Sets the value of the knock property.
void	setTrigger(CommodityTrigger value)	Sets the value of the trigger property.

Methods inherited from class java.lang.Object

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

Field Details

knock

protected CommodityKnockEnum knock

featurePaymentAmount

protected PositiveMoney featurePaymentAmount

trigger

protected CommodityTrigger trigger

Constructor Details

CommodityBarrier

public CommodityBarrier()

Method Details

getKnock

public CommodityKnockEnum getKnock()

Gets the value of the knock property.

Returns:

possible object is CommodityKnockEnum

setKnock

public void setKnock(CommodityKnockEnum value)

Sets the value of the knock property.

Parameters:

value - allowed object is CommodityKnockEnum

getFeaturePaymentAmount

public PositiveMoney getFeaturePaymentAmount()

Gets the value of the featurePaymentAmount property.

Returns:

possible object is PositiveMoney

setFeaturePaymentAmount

public void setFeaturePaymentAmount(PositiveMoney value)

Sets the value of the featurePaymentAmount property.

Parameters:

value - allowed object is PositiveMoney

getTrigger

public CommodityTrigger getTrigger()

Gets the value of the trigger property.

Returns:

possible object is CommodityTrigger

setTrigger

public void setTrigger(CommodityTrigger value)

Sets the value of the trigger property.

Parameters:

value - allowed object is CommodityTrigger