Class FloatingPriceLeg
java.lang.Object
net.finmath.smartcontract.product.xml.Leg
net.finmath.smartcontract.product.xml.CommoditySwapLeg
net.finmath.smartcontract.product.xml.FinancialSwapLeg
net.finmath.smartcontract.product.xml.FloatingPriceLeg
Floating Price Leg of a Commodity Swap. Each 'floatingLeg' defines a series
of financial payments for a commodity the value of which is derived from a floating price such as an
exchange or an index publication.
Java class for FloatingPriceLeg complex type.
The following schema fragment specifies the expected content contained within this class.
<complexType name="FloatingPriceLeg"> <complexContent> <extension base="{http://www.fpml.org/FpML-5/confirmation}FinancialSwapLeg"> <sequence> <group ref="{http://www.fpml.org/FpML-5/confirmation}CommodityCalculationPeriods.model"/> <element name="commodity" type="{http://www.fpml.org/FpML-5/confirmation}Commodity"/> <group ref="{http://www.fpml.org/FpML-5/confirmation}CommodityNotionalQuantity.model"/> <element name="calculation" type="{http://www.fpml.org/FpML-5/confirmation}FloatingLegCalculation"/> <group ref="{http://www.fpml.org/FpML-5/confirmation}CommodityPaymentDates.model"/> <group ref="{http://www.fpml.org/FpML-5/confirmation}CommodityFreightFlatRate.model" minOccurs="0"/> </sequence> </extension> </complexContent> </complexType>
-
Field Summary
Modifier and TypeFieldDescriptionprotected FloatingLegCalculation
protected AdjustableDates
protected AdjustableDates
protected CalculationPeriodsDatesReference
protected CalculationPeriodsReference
protected CommodityCalculationPeriodsSchedule
protected CalculationPeriodsScheduleReference
protected Commodity
protected FlatRateEnum
protected NonNegativeMoney
protected Boolean
protected CommodityNotionalQuantity
protected CommodityNotionalQuantitySchedule
protected AdjustableDatesOrRelativeDateOffset
protected QuantityReference
protected CommodityRelativePaymentDates
protected List
<CommoditySettlementPeriodsNotionalQuantity> protected BigDecimal
Fields inherited from class net.finmath.smartcontract.product.xml.FinancialSwapLeg
payerAccountReference, payerPartyReference, receiverAccountReference, receiverPartyReference
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGets the value of the calculation property.Gets the value of the calculationDates property.Gets the value of the calculationPeriods property.Gets the value of the calculationPeriodsDatesReference property.Gets the value of the calculationPeriodsReference property.Gets the value of the calculationPeriodsSchedule property.Gets the value of the calculationPeriodsScheduleReference property.Gets the value of the commodity property.Gets the value of the flatRate property.Gets the value of the flatRateAmount property.Gets the value of the notionalQuantity property.Gets the value of the notionalQuantitySchedule property.Gets the value of the paymentDates property.Gets the value of the quantityReference property.Gets the value of the relativePaymentDates property.Gets the value of the settlementPeriodsNotionalQuantity property.Gets the value of the totalNotionalQuantity property.Gets the value of the masterAgreementPaymentDates property.void
Sets the value of the calculation property.void
Sets the value of the calculationDates property.void
Sets the value of the calculationPeriods property.void
Sets the value of the calculationPeriodsDatesReference property.void
Sets the value of the calculationPeriodsReference property.void
Sets the value of the calculationPeriodsSchedule property.void
Sets the value of the calculationPeriodsScheduleReference property.void
setCommodity
(Commodity value) Sets the value of the commodity property.void
setFlatRate
(FlatRateEnum value) Sets the value of the flatRate property.void
Sets the value of the flatRateAmount property.void
Sets the value of the masterAgreementPaymentDates property.void
Sets the value of the notionalQuantity property.void
Sets the value of the notionalQuantitySchedule property.void
Sets the value of the paymentDates property.void
Sets the value of the quantityReference property.void
Sets the value of the relativePaymentDates property.void
Sets the value of the totalNotionalQuantity property.Methods inherited from class net.finmath.smartcontract.product.xml.FinancialSwapLeg
getPayerAccountReference, getPayerPartyReference, getReceiverAccountReference, getReceiverPartyReference, setPayerAccountReference, setPayerPartyReference, setReceiverAccountReference, setReceiverPartyReference
-
Field Details
-
calculationDates
-
calculationPeriods
-
calculationPeriodsSchedule
-
calculationPeriodsReference
-
calculationPeriodsScheduleReference
-
calculationPeriodsDatesReference
-
commodity
-
notionalQuantitySchedule
-
notionalQuantity
-
settlementPeriodsNotionalQuantity
-
totalNotionalQuantity
-
quantityReference
-
calculation
-
relativePaymentDates
-
paymentDates
-
masterAgreementPaymentDates
-
flatRate
-
flatRateAmount
-
-
Constructor Details
-
FloatingPriceLeg
public FloatingPriceLeg()
-
-
Method Details
-
getCalculationDates
Gets the value of the calculationDates property.- Returns:
- possible object is
AdjustableDates
-
setCalculationDates
Sets the value of the calculationDates property.- Parameters:
value
- allowed object isAdjustableDates
-
getCalculationPeriods
Gets the value of the calculationPeriods property.- Returns:
- possible object is
AdjustableDates
-
setCalculationPeriods
Sets the value of the calculationPeriods property.- Parameters:
value
- allowed object isAdjustableDates
-
getCalculationPeriodsSchedule
Gets the value of the calculationPeriodsSchedule property.- Returns:
- possible object is
CommodityCalculationPeriodsSchedule
-
setCalculationPeriodsSchedule
Sets the value of the calculationPeriodsSchedule property.- Parameters:
value
- allowed object isCommodityCalculationPeriodsSchedule
-
getCalculationPeriodsReference
Gets the value of the calculationPeriodsReference property.- Returns:
- possible object is
CalculationPeriodsReference
-
setCalculationPeriodsReference
Sets the value of the calculationPeriodsReference property.- Parameters:
value
- allowed object isCalculationPeriodsReference
-
getCalculationPeriodsScheduleReference
Gets the value of the calculationPeriodsScheduleReference property.- Returns:
- possible object is
CalculationPeriodsScheduleReference
-
setCalculationPeriodsScheduleReference
Sets the value of the calculationPeriodsScheduleReference property.- Parameters:
value
- allowed object isCalculationPeriodsScheduleReference
-
getCalculationPeriodsDatesReference
Gets the value of the calculationPeriodsDatesReference property.- Returns:
- possible object is
CalculationPeriodsDatesReference
-
setCalculationPeriodsDatesReference
Sets the value of the calculationPeriodsDatesReference property.- Parameters:
value
- allowed object isCalculationPeriodsDatesReference
-
getCommodity
-
setCommodity
-
getNotionalQuantitySchedule
Gets the value of the notionalQuantitySchedule property.- Returns:
- possible object is
CommodityNotionalQuantitySchedule
-
setNotionalQuantitySchedule
Sets the value of the notionalQuantitySchedule property.- Parameters:
value
- allowed object isCommodityNotionalQuantitySchedule
-
getNotionalQuantity
Gets the value of the notionalQuantity property.- Returns:
- possible object is
CommodityNotionalQuantity
-
setNotionalQuantity
Sets the value of the notionalQuantity property.- Parameters:
value
- allowed object isCommodityNotionalQuantity
-
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
Gets the value of the totalNotionalQuantity property.- Returns:
- possible object is
BigDecimal
-
setTotalNotionalQuantity
Sets the value of the totalNotionalQuantity property.- Parameters:
value
- allowed object isBigDecimal
-
getQuantityReference
Gets the value of the quantityReference property.- Returns:
- possible object is
QuantityReference
-
setQuantityReference
Sets the value of the quantityReference property.- Parameters:
value
- allowed object isQuantityReference
-
getCalculation
Gets the value of the calculation property.- Returns:
- possible object is
FloatingLegCalculation
-
setCalculation
Sets the value of the calculation property.- Parameters:
value
- allowed object isFloatingLegCalculation
-
getRelativePaymentDates
Gets the value of the relativePaymentDates property.- Returns:
- possible object is
CommodityRelativePaymentDates
-
setRelativePaymentDates
Sets the value of the relativePaymentDates property.- Parameters:
value
- allowed object isCommodityRelativePaymentDates
-
getPaymentDates
Gets the value of the paymentDates property.- Returns:
- possible object is
AdjustableDatesOrRelativeDateOffset
-
setPaymentDates
Sets the value of the paymentDates property.- Parameters:
value
- allowed object isAdjustableDatesOrRelativeDateOffset
-
isMasterAgreementPaymentDates
-
setMasterAgreementPaymentDates
-
getFlatRate
Gets the value of the flatRate property.- Returns:
- possible object is
FlatRateEnum
-
setFlatRate
Sets the value of the flatRate property.- Parameters:
value
- allowed object isFlatRateEnum
-
getFlatRateAmount
Gets the value of the flatRateAmount property.- Returns:
- possible object is
NonNegativeMoney
-
setFlatRateAmount
Sets the value of the flatRateAmount property.- Parameters:
value
- allowed object isNonNegativeMoney
-