Package net.finmath.smartcontract.product.xml

Class Commodity

java.lang.Object

net.finmath.smartcontract.product.xml.Asset

net.finmath.smartcontract.product.xml.IdentifiedAsset

net.finmath.smartcontract.product.xml.Commodity

public class Commodity
extends IdentifiedAsset

A type describing a commodity underlying asset.

Java class for Commodity complex type.

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

 <complexType name="Commodity">
   <complexContent>
     <extension base="{http://www.fpml.org/FpML-5/confirmation}IdentifiedAsset">
       <sequence>
         <group ref="{http://www.fpml.org/FpML-5/confirmation}CommodityProduct.model"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field	Description
protected CommodityBase	commodityBase
protected CommodityDetails	commodityDetails
protected Currency	currency
protected AdjustableDate	deliveryDate
protected Offset	deliveryDateExpirationConvention
protected Offset	deliveryDateRollConvention
protected DeliveryDatesEnum	deliveryDates
protected XMLGregorianCalendar	deliveryDateYearMonth
protected DeliveryNearby	deliveryNearby
protected ExchangeId	exchangeId
protected BigDecimal	multiplier
protected CommodityInformationSource	publication
protected SpecifiedPriceEnum	specifiedPrice
protected QuantityUnit	unit

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

description, instrumentId

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

id

Constructor Summary

Constructors

Constructor	Description
Commodity()

Method Summary

Modifier and Type	Method	Description
CommodityBase	getCommodityBase()	Gets the value of the commodityBase property.
CommodityDetails	getCommodityDetails()	Gets the value of the commodityDetails property.
Currency	getCurrency()	Gets the value of the currency property.
AdjustableDate	getDeliveryDate()	Gets the value of the deliveryDate property.
Offset	getDeliveryDateExpirationConvention()	Gets the value of the deliveryDateExpirationConvention property.
Offset	getDeliveryDateRollConvention()	Gets the value of the deliveryDateRollConvention property.
DeliveryDatesEnum	getDeliveryDates()	Gets the value of the deliveryDates property.
XMLGregorianCalendar	getDeliveryDateYearMonth()	Gets the value of the deliveryDateYearMonth property.
DeliveryNearby	getDeliveryNearby()	Gets the value of the deliveryNearby property.
ExchangeId	getExchangeId()	Gets the value of the exchangeId property.
BigDecimal	getMultiplier()	Gets the value of the multiplier property.
CommodityInformationSource	getPublication()	Gets the value of the publication property.
SpecifiedPriceEnum	getSpecifiedPrice()	Gets the value of the specifiedPrice property.
QuantityUnit	getUnit()	Gets the value of the unit property.
void	setCommodityBase(CommodityBase value)	Sets the value of the commodityBase property.
void	setCommodityDetails(CommodityDetails value)	Sets the value of the commodityDetails property.
void	setCurrency(Currency value)	Sets the value of the currency property.
void	setDeliveryDate(AdjustableDate value)	Sets the value of the deliveryDate property.
void	setDeliveryDateExpirationConvention(Offset value)	Sets the value of the deliveryDateExpirationConvention property.
void	setDeliveryDateRollConvention(Offset value)	Sets the value of the deliveryDateRollConvention property.
void	setDeliveryDates(DeliveryDatesEnum value)	Sets the value of the deliveryDates property.
void	setDeliveryDateYearMonth(XMLGregorianCalendar value)	Sets the value of the deliveryDateYearMonth property.
void	setDeliveryNearby(DeliveryNearby value)	Sets the value of the deliveryNearby property.
void	setExchangeId(ExchangeId value)	Sets the value of the exchangeId property.
void	setMultiplier(BigDecimal value)	Sets the value of the multiplier property.
void	setPublication(CommodityInformationSource value)	Sets the value of the publication property.
void	setSpecifiedPrice(SpecifiedPriceEnum value)	Sets the value of the specifiedPrice property.
void	setUnit(QuantityUnit value)	Sets the value of the unit property.

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

getDescription, getInstrumentId, setDescription

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

getId, setId

Methods inherited from class java.lang.Object

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

Field Details

commodityBase

protected CommodityBase commodityBase

commodityDetails

protected CommodityDetails commodityDetails

unit

protected QuantityUnit unit

currency

protected Currency currency

exchangeId

protected ExchangeId exchangeId

publication

protected CommodityInformationSource publication

specifiedPrice

protected SpecifiedPriceEnum specifiedPrice

deliveryDates

protected DeliveryDatesEnum deliveryDates

deliveryNearby

protected DeliveryNearby deliveryNearby

deliveryDate

protected AdjustableDate deliveryDate

deliveryDateYearMonth

protected XMLGregorianCalendar deliveryDateYearMonth

deliveryDateRollConvention

protected Offset deliveryDateRollConvention

deliveryDateExpirationConvention

protected Offset deliveryDateExpirationConvention

multiplier

protected BigDecimal multiplier

Constructor Details

Commodity

public Commodity()

Method Details

getCommodityBase

public CommodityBase getCommodityBase()

Gets the value of the commodityBase property.

Returns:

possible object is CommodityBase

setCommodityBase

public void setCommodityBase(CommodityBase value)

Sets the value of the commodityBase property.

Parameters:

value - allowed object is CommodityBase

getCommodityDetails

public CommodityDetails getCommodityDetails()

Gets the value of the commodityDetails property.

Returns:

possible object is CommodityDetails

setCommodityDetails

public void setCommodityDetails(CommodityDetails value)

Sets the value of the commodityDetails property.

Parameters:

value - allowed object is CommodityDetails

getUnit

public QuantityUnit getUnit()

Gets the value of the unit property.

Returns:

possible object is QuantityUnit

setUnit

public void setUnit(QuantityUnit value)

Sets the value of the unit property.

Parameters:

value - allowed object is QuantityUnit

getCurrency

public Currency getCurrency()

Gets the value of the currency property.

Returns:

possible object is Currency

setCurrency

public void setCurrency(Currency value)

Sets the value of the currency property.

Parameters:

value - allowed object is Currency

getExchangeId

public ExchangeId getExchangeId()

Gets the value of the exchangeId property.

Returns:

possible object is ExchangeId

setExchangeId

public void setExchangeId(ExchangeId value)

Sets the value of the exchangeId property.

Parameters:

value - allowed object is ExchangeId

getPublication

public CommodityInformationSource getPublication()

Gets the value of the publication property.

Returns:

possible object is CommodityInformationSource

setPublication

public void setPublication(CommodityInformationSource value)

Sets the value of the publication property.

Parameters:

value - allowed object is CommodityInformationSource

getSpecifiedPrice

public SpecifiedPriceEnum getSpecifiedPrice()

Gets the value of the specifiedPrice property.

Returns:

possible object is SpecifiedPriceEnum

setSpecifiedPrice

public void setSpecifiedPrice(SpecifiedPriceEnum value)

Sets the value of the specifiedPrice property.

Parameters:

value - allowed object is SpecifiedPriceEnum

getDeliveryDates

public DeliveryDatesEnum getDeliveryDates()

Gets the value of the deliveryDates property.

Returns:

possible object is DeliveryDatesEnum

setDeliveryDates

public void setDeliveryDates(DeliveryDatesEnum value)

Sets the value of the deliveryDates property.

Parameters:

value - allowed object is DeliveryDatesEnum

getDeliveryNearby

public DeliveryNearby getDeliveryNearby()

Gets the value of the deliveryNearby property.

Returns:

possible object is DeliveryNearby

setDeliveryNearby

public void setDeliveryNearby(DeliveryNearby value)

Sets the value of the deliveryNearby property.

Parameters:

value - allowed object is DeliveryNearby

getDeliveryDate

public AdjustableDate getDeliveryDate()

Gets the value of the deliveryDate property.

Returns:

possible object is AdjustableDate

setDeliveryDate

public void setDeliveryDate(AdjustableDate value)

Sets the value of the deliveryDate property.

Parameters:

value - allowed object is AdjustableDate

getDeliveryDateYearMonth

public XMLGregorianCalendar getDeliveryDateYearMonth()

Gets the value of the deliveryDateYearMonth property.

Returns:

possible object is XMLGregorianCalendar

setDeliveryDateYearMonth

public void setDeliveryDateYearMonth(XMLGregorianCalendar value)

Sets the value of the deliveryDateYearMonth property.

Parameters:

value - allowed object is XMLGregorianCalendar

getDeliveryDateRollConvention

public Offset getDeliveryDateRollConvention()

Gets the value of the deliveryDateRollConvention property.

Returns:

possible object is Offset

setDeliveryDateRollConvention

public void setDeliveryDateRollConvention(Offset value)

Sets the value of the deliveryDateRollConvention property.

Parameters:

value - allowed object is Offset

getDeliveryDateExpirationConvention

public Offset getDeliveryDateExpirationConvention()

Gets the value of the deliveryDateExpirationConvention property.

Returns:

possible object is Offset

setDeliveryDateExpirationConvention

public void setDeliveryDateExpirationConvention(Offset value)

Sets the value of the deliveryDateExpirationConvention property.

Parameters:

value - allowed object is Offset

getMultiplier

public BigDecimal getMultiplier()

Gets the value of the multiplier property.

Returns:

possible object is BigDecimal

setMultiplier

public void setMultiplier(BigDecimal value)

Sets the value of the multiplier property.

Parameters:

value - allowed object is BigDecimal