Package net.finmath.smartcontract.product.xml

Class CommodityBasketUnderlyingByNotional

java.lang.Object

net.finmath.smartcontract.product.xml.CommodityBasketUnderlyingBase

net.finmath.smartcontract.product.xml.CommodityBasketUnderlyingByNotional

public class CommodityBasketUnderlyingByNotional
extends CommodityBasketUnderlyingBase

Java class for CommodityBasketUnderlyingByNotional complex type.

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

 <complexType name="CommodityBasketUnderlyingByNotional">
   <complexContent>
     <extension base="{http://www.fpml.org/FpML-5/confirmation}CommodityBasketUnderlyingBase">
       <sequence>
         <element name="fx" type="{http://www.fpml.org/FpML-5/confirmation}CommodityFx" minOccurs="0"/>
         <element name="conversionFactor" type="{http://www.w3.org/2001/XMLSchema}decimal" minOccurs="0"/>
         <group ref="{http://www.fpml.org/FpML-5/confirmation}CommodityNotionalQuantity.model"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field	Description
protected BigDecimal	conversionFactor
protected CommodityFx	fx
protected CommodityNotionalQuantity	notionalQuantity
protected CommodityNotionalQuantitySchedule	notionalQuantitySchedule
protected QuantityReference	quantityReference
protected List<CommoditySettlementPeriodsNotionalQuantity>	settlementPeriodsNotionalQuantity
protected BigDecimal	totalNotionalQuantity

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

averagingMethod, commodity, direction, id, pricingDates

Constructor Summary

Constructors

Constructor	Description
CommodityBasketUnderlyingByNotional()

Method Summary

Modifier and Type	Method	Description
BigDecimal	getConversionFactor()	Gets the value of the conversionFactor property.
CommodityFx	getFx()	Gets the value of the fx property.
CommodityNotionalQuantity	getNotionalQuantity()	Gets the value of the notionalQuantity property.
CommodityNotionalQuantitySchedule	getNotionalQuantitySchedule()	Gets the value of the notionalQuantitySchedule property.
QuantityReference	getQuantityReference()	Gets the value of the quantityReference property.
List<CommoditySettlementPeriodsNotionalQuantity>	getSettlementPeriodsNotionalQuantity()	Gets the value of the settlementPeriodsNotionalQuantity property.
BigDecimal	getTotalNotionalQuantity()	Gets the value of the totalNotionalQuantity property.
void	setConversionFactor(BigDecimal value)	Sets the value of the conversionFactor property.
void	setFx(CommodityFx value)	Sets the value of the fx property.
void	setNotionalQuantity(CommodityNotionalQuantity value)	Sets the value of the notionalQuantity property.
void	setNotionalQuantitySchedule(CommodityNotionalQuantitySchedule value)	Sets the value of the notionalQuantitySchedule property.
void	setQuantityReference(QuantityReference value)	Sets the value of the quantityReference property.
void	setTotalNotionalQuantity(BigDecimal value)	Sets the value of the totalNotionalQuantity property.

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

getAveragingMethod, getCommodity, getDirection, getId, getPricingDates, setAveragingMethod, setCommodity, setDirection, setId, setPricingDates

Methods inherited from class java.lang.Object

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

Field Details

fx

protected CommodityFx fx

conversionFactor

protected BigDecimal conversionFactor

notionalQuantitySchedule

protected CommodityNotionalQuantitySchedule notionalQuantitySchedule

notionalQuantity

protected CommodityNotionalQuantity notionalQuantity

settlementPeriodsNotionalQuantity

protected List<CommoditySettlementPeriodsNotionalQuantity> settlementPeriodsNotionalQuantity

totalNotionalQuantity

protected BigDecimal totalNotionalQuantity

quantityReference

protected QuantityReference quantityReference

Constructor Details

CommodityBasketUnderlyingByNotional

public CommodityBasketUnderlyingByNotional()

Method Details

getFx

public CommodityFx getFx()

Gets the value of the fx property.

Returns:

possible object is CommodityFx

setFx

public void setFx(CommodityFx value)

Sets the value of the fx property.

Parameters:

value - allowed object is CommodityFx

getConversionFactor

public BigDecimal getConversionFactor()

Gets the value of the conversionFactor property.

Returns:

possible object is BigDecimal

setConversionFactor

public void setConversionFactor(BigDecimal value)

Sets the value of the conversionFactor property.

Parameters:

value - allowed object is BigDecimal

getNotionalQuantitySchedule

public CommodityNotionalQuantitySchedule getNotionalQuantitySchedule()

Gets the value of the notionalQuantitySchedule property.

Returns:

possible object is CommodityNotionalQuantitySchedule

setNotionalQuantitySchedule

public void setNotionalQuantitySchedule(CommodityNotionalQuantitySchedule value)

Sets the value of the notionalQuantitySchedule property.

Parameters:

value - allowed object is CommodityNotionalQuantitySchedule

getNotionalQuantity

public CommodityNotionalQuantity getNotionalQuantity()

Gets the value of the notionalQuantity property.

Returns:

possible object is CommodityNotionalQuantity

setNotionalQuantity

public void setNotionalQuantity(CommodityNotionalQuantity value)

Sets the value of the notionalQuantity property.

Parameters:

value - allowed object is CommodityNotionalQuantity

getSettlementPeriodsNotionalQuantity

public List<CommoditySettlementPeriodsNotionalQuantity> getSettlementPeriodsNotionalQuantity()

Gets the value of the settlementPeriodsNotionalQuantity 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 settlementPeriodsNotionalQuantity property.

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

    getSettlementPeriodsNotionalQuantity().add(newItem);
 

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

getTotalNotionalQuantity

public BigDecimal getTotalNotionalQuantity()

Gets the value of the totalNotionalQuantity property.

Returns:

possible object is BigDecimal

setTotalNotionalQuantity

public void setTotalNotionalQuantity(BigDecimal value)

Sets the value of the totalNotionalQuantity property.

Parameters:

value - allowed object is BigDecimal

getQuantityReference

public QuantityReference getQuantityReference()

Gets the value of the quantityReference property.

Returns:

possible object is QuantityReference

setQuantityReference

public void setQuantityReference(QuantityReference value)

Sets the value of the quantityReference property.

Parameters:

value - allowed object is QuantityReference