Package net.finmath.smartcontract.product.xml

Class MetalPhysicalLeg

java.lang.Object

net.finmath.smartcontract.product.xml.Leg

net.finmath.smartcontract.product.xml.CommodityForwardLeg

net.finmath.smartcontract.product.xml.PhysicalForwardLeg

net.finmath.smartcontract.product.xml.MetalPhysicalLeg

public class MetalPhysicalLeg
extends PhysicalForwardLeg

Physically settled leg of a physically settled Metal transaction.

Java class for MetalPhysicalLeg complex type.

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

 <complexType name="MetalPhysicalLeg">
   <complexContent>
     <extension base="{http://www.fpml.org/FpML-5/confirmation}PhysicalForwardLeg">
       <sequence>
         <element name="metal" type="{http://www.fpml.org/FpML-5/confirmation}Metal"/>
         <element name="deliveryPeriods" type="{http://www.fpml.org/FpML-5/confirmation}CommodityDeliveryPeriods"/>
         <element name="deliveryConditions" type="{http://www.fpml.org/FpML-5/confirmation}MetalDelivery"/>
         <group ref="{http://www.fpml.org/FpML-5/confirmation}CommodityFixedPhysicalQuantity.model"/>
         <element name="conversionFactor" type="{http://www.w3.org/2001/XMLSchema}decimal" minOccurs="0"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field	Description
protected BigDecimal	conversionFactor
protected MetalDelivery	deliveryConditions
protected CommodityDeliveryPeriods	deliveryPeriods
protected Metal	metal
protected CommodityNotionalQuantity	physicalQuantity
protected CommodityPhysicalQuantitySchedule	physicalQuantitySchedule
protected UnitQuantity	totalPhysicalQuantity

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

payerAccountReference, payerPartyReference, receiverAccountReference, receiverPartyReference

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

id

Constructor Summary

Constructors

Constructor	Description
MetalPhysicalLeg()

Method Summary

Modifier and Type	Method	Description
BigDecimal	getConversionFactor()	Gets the value of the conversionFactor property.
MetalDelivery	getDeliveryConditions()	Gets the value of the deliveryConditions property.
CommodityDeliveryPeriods	getDeliveryPeriods()	Gets the value of the deliveryPeriods property.
Metal	getMetal()	Gets the value of the metal property.
CommodityNotionalQuantity	getPhysicalQuantity()	Gets the value of the physicalQuantity property.
CommodityPhysicalQuantitySchedule	getPhysicalQuantitySchedule()	Gets the value of the physicalQuantitySchedule property.
UnitQuantity	getTotalPhysicalQuantity()	Gets the value of the totalPhysicalQuantity property.
void	setConversionFactor(BigDecimal value)	Sets the value of the conversionFactor property.
void	setDeliveryConditions(MetalDelivery value)	Sets the value of the deliveryConditions property.
void	setDeliveryPeriods(CommodityDeliveryPeriods value)	Sets the value of the deliveryPeriods property.
void	setMetal(Metal value)	Sets the value of the metal property.
void	setPhysicalQuantity(CommodityNotionalQuantity value)	Sets the value of the physicalQuantity property.
void	setPhysicalQuantitySchedule(CommodityPhysicalQuantitySchedule value)	Sets the value of the physicalQuantitySchedule property.
void	setTotalPhysicalQuantity(UnitQuantity value)	Sets the value of the totalPhysicalQuantity property.

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

getPayerAccountReference, getPayerPartyReference, getReceiverAccountReference, getReceiverPartyReference, setPayerAccountReference, setPayerPartyReference, setReceiverAccountReference, setReceiverPartyReference

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

getId, setId

Methods inherited from class java.lang.Object

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

Field Details

metal

protected Metal metal

deliveryPeriods

protected CommodityDeliveryPeriods deliveryPeriods

deliveryConditions

protected MetalDelivery deliveryConditions

physicalQuantity

protected CommodityNotionalQuantity physicalQuantity

physicalQuantitySchedule

protected CommodityPhysicalQuantitySchedule physicalQuantitySchedule

totalPhysicalQuantity

protected UnitQuantity totalPhysicalQuantity

conversionFactor

protected BigDecimal conversionFactor

Constructor Details

MetalPhysicalLeg

public MetalPhysicalLeg()

Method Details

getMetal

public Metal getMetal()

Gets the value of the metal property.

Returns:

possible object is Metal

setMetal

public void setMetal(Metal value)

Sets the value of the metal property.

Parameters:

value - allowed object is Metal

getDeliveryPeriods

public CommodityDeliveryPeriods getDeliveryPeriods()

Gets the value of the deliveryPeriods property.

Returns:

possible object is CommodityDeliveryPeriods

setDeliveryPeriods

public void setDeliveryPeriods(CommodityDeliveryPeriods value)

Sets the value of the deliveryPeriods property.

Parameters:

value - allowed object is CommodityDeliveryPeriods

getDeliveryConditions

public MetalDelivery getDeliveryConditions()

Gets the value of the deliveryConditions property.

Returns:

possible object is MetalDelivery

setDeliveryConditions

public void setDeliveryConditions(MetalDelivery value)

Sets the value of the deliveryConditions property.

Parameters:

value - allowed object is MetalDelivery

getPhysicalQuantity

public CommodityNotionalQuantity getPhysicalQuantity()

Gets the value of the physicalQuantity property.

Returns:

possible object is CommodityNotionalQuantity

setPhysicalQuantity

public void setPhysicalQuantity(CommodityNotionalQuantity value)

Sets the value of the physicalQuantity property.

Parameters:

value - allowed object is CommodityNotionalQuantity

getPhysicalQuantitySchedule

public CommodityPhysicalQuantitySchedule getPhysicalQuantitySchedule()

Gets the value of the physicalQuantitySchedule property.

Returns:

possible object is CommodityPhysicalQuantitySchedule

setPhysicalQuantitySchedule

public void setPhysicalQuantitySchedule(CommodityPhysicalQuantitySchedule value)

Sets the value of the physicalQuantitySchedule property.

Parameters:

value - allowed object is CommodityPhysicalQuantitySchedule

getTotalPhysicalQuantity

public UnitQuantity getTotalPhysicalQuantity()

Gets the value of the totalPhysicalQuantity property.

Returns:

possible object is UnitQuantity

setTotalPhysicalQuantity

public void setTotalPhysicalQuantity(UnitQuantity value)

Sets the value of the totalPhysicalQuantity property.

Parameters:

value - allowed object is UnitQuantity

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