Package net.finmath.smartcontract.product.xml

Class CommodityTrigger

java.lang.Object

net.finmath.smartcontract.product.xml.CommodityTrigger

public class CommodityTrigger
extends Object

The barrier which, when breached, triggers the knock-in or knock-out of the barrier option.

Java class for CommodityTrigger complex type.

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

 <complexType name="CommodityTrigger">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <choice>
           <sequence>
             <element name="levelQuantity" type="{http://www.w3.org/2001/XMLSchema}decimal"/>
             <element name="levelUnit" type="{http://www.fpml.org/FpML-5/confirmation}QuantityUnit"/>
           </sequence>
           <element name="levelPercentage" type="{http://www.w3.org/2001/XMLSchema}decimal"/>
           <element name="levelPrice" type="{http://www.fpml.org/FpML-5/confirmation}FixedPrice"/>
         </choice>
         <element name="triggerType" type="{http://www.fpml.org/FpML-5/confirmation}TriggerTypeEnum"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field	Description
protected BigDecimal	levelPercentage
protected FixedPrice	levelPrice
protected BigDecimal	levelQuantity
protected QuantityUnit	levelUnit
protected TriggerTypeEnum	triggerType

Constructor Summary

Constructors

Constructor	Description
CommodityTrigger()

Method Summary

Modifier and Type	Method	Description
BigDecimal	getLevelPercentage()	Gets the value of the levelPercentage property.
FixedPrice	getLevelPrice()	Gets the value of the levelPrice property.
BigDecimal	getLevelQuantity()	Gets the value of the levelQuantity property.
QuantityUnit	getLevelUnit()	Gets the value of the levelUnit property.
TriggerTypeEnum	getTriggerType()	Gets the value of the triggerType property.
void	setLevelPercentage(BigDecimal value)	Sets the value of the levelPercentage property.
void	setLevelPrice(FixedPrice value)	Sets the value of the levelPrice property.
void	setLevelQuantity(BigDecimal value)	Sets the value of the levelQuantity property.
void	setLevelUnit(QuantityUnit value)	Sets the value of the levelUnit property.
void	setTriggerType(TriggerTypeEnum value)	Sets the value of the triggerType property.

Methods inherited from class java.lang.Object

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

Field Details

levelQuantity

protected BigDecimal levelQuantity

levelUnit

protected QuantityUnit levelUnit

levelPercentage

protected BigDecimal levelPercentage

levelPrice

protected FixedPrice levelPrice

triggerType

protected TriggerTypeEnum triggerType

Constructor Details

CommodityTrigger

public CommodityTrigger()

Method Details

getLevelQuantity

public BigDecimal getLevelQuantity()

Gets the value of the levelQuantity property.

Returns:

possible object is BigDecimal

setLevelQuantity

public void setLevelQuantity(BigDecimal value)

Sets the value of the levelQuantity property.

Parameters:

value - allowed object is BigDecimal

getLevelUnit

public QuantityUnit getLevelUnit()

Gets the value of the levelUnit property.

Returns:

possible object is QuantityUnit

setLevelUnit

public void setLevelUnit(QuantityUnit value)

Sets the value of the levelUnit property.

Parameters:

value - allowed object is QuantityUnit

getLevelPercentage

public BigDecimal getLevelPercentage()

Gets the value of the levelPercentage property.

Returns:

possible object is BigDecimal

setLevelPercentage

public void setLevelPercentage(BigDecimal value)

Sets the value of the levelPercentage property.

Parameters:

value - allowed object is BigDecimal

getLevelPrice

public FixedPrice getLevelPrice()

Gets the value of the levelPrice property.

Returns:

possible object is FixedPrice

setLevelPrice

public void setLevelPrice(FixedPrice value)

Sets the value of the levelPrice property.

Parameters:

value - allowed object is FixedPrice

getTriggerType

public TriggerTypeEnum getTriggerType()

Gets the value of the triggerType property.

Returns:

possible object is TriggerTypeEnum

setTriggerType

public void setTriggerType(TriggerTypeEnum value)

Sets the value of the triggerType property.

Parameters:

value - allowed object is TriggerTypeEnum