Class NotionalStepRule
java.lang.Object
net.finmath.smartcontract.product.xml.NotionalStepRule
A type defining a parametric representation of the notional step schedule,
i.e. parameters used to generate the notional balance on each step date. The step change in notional can
be expressed in terms of either a fixed amount or as a percentage of either the initial notional or
previous notional amount. This parametric representation is intended to cover the more common
amortizing/accreting.
Java class for NotionalStepRule complex type.
The following schema fragment specifies the expected content contained within this class.
<complexType name="NotionalStepRule"> <complexContent> <restriction base="{http://www.w3.org/2001/XMLSchema}anyType"> <sequence> <element name="calculationPeriodDatesReference" type="{http://www.fpml.org/FpML-5/confirmation}CalculationPeriodDatesReference"/> <element name="stepFrequency" type="{http://www.fpml.org/FpML-5/confirmation}Frequency"/> <element name="firstNotionalStepDate" type="{http://www.w3.org/2001/XMLSchema}date"/> <element name="lastNotionalStepDate" type="{http://www.w3.org/2001/XMLSchema}date"/> <choice> <element name="notionalStepAmount" type="{http://www.w3.org/2001/XMLSchema}decimal"/> <sequence> <element name="notionalStepRate" type="{http://www.w3.org/2001/XMLSchema}decimal"/> <element name="stepRelativeTo" type="{http://www.fpml.org/FpML-5/confirmation}StepRelativeToEnum"/> </sequence> </choice> </sequence> </restriction> </complexContent> </complexType>
-
Field Summary
Modifier and TypeFieldDescriptionprotected CalculationPeriodDatesReference
protected XMLGregorianCalendar
protected XMLGregorianCalendar
protected BigDecimal
protected BigDecimal
protected Frequency
protected StepRelativeToEnum
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGets the value of the calculationPeriodDatesReference property.Gets the value of the firstNotionalStepDate property.Gets the value of the lastNotionalStepDate property.Gets the value of the notionalStepAmount property.Gets the value of the notionalStepRate property.Gets the value of the stepFrequency property.Gets the value of the stepRelativeTo property.void
Sets the value of the calculationPeriodDatesReference property.void
Sets the value of the firstNotionalStepDate property.void
Sets the value of the lastNotionalStepDate property.void
setNotionalStepAmount
(BigDecimal value) Sets the value of the notionalStepAmount property.void
setNotionalStepRate
(BigDecimal value) Sets the value of the notionalStepRate property.void
setStepFrequency
(Frequency value) Sets the value of the stepFrequency property.void
Sets the value of the stepRelativeTo property.
-
Field Details
-
calculationPeriodDatesReference
-
stepFrequency
-
firstNotionalStepDate
-
lastNotionalStepDate
-
notionalStepAmount
-
notionalStepRate
-
stepRelativeTo
-
-
Constructor Details
-
NotionalStepRule
public NotionalStepRule()
-
-
Method Details
-
getCalculationPeriodDatesReference
Gets the value of the calculationPeriodDatesReference property.- Returns:
- possible object is
CalculationPeriodDatesReference
-
setCalculationPeriodDatesReference
Sets the value of the calculationPeriodDatesReference property.- Parameters:
value
- allowed object isCalculationPeriodDatesReference
-
getStepFrequency
-
setStepFrequency
-
getFirstNotionalStepDate
Gets the value of the firstNotionalStepDate property.- Returns:
- possible object is
XMLGregorianCalendar
-
setFirstNotionalStepDate
Sets the value of the firstNotionalStepDate property.- Parameters:
value
- allowed object isXMLGregorianCalendar
-
getLastNotionalStepDate
Gets the value of the lastNotionalStepDate property.- Returns:
- possible object is
XMLGregorianCalendar
-
setLastNotionalStepDate
Sets the value of the lastNotionalStepDate property.- Parameters:
value
- allowed object isXMLGregorianCalendar
-
getNotionalStepAmount
Gets the value of the notionalStepAmount property.- Returns:
- possible object is
BigDecimal
-
setNotionalStepAmount
Sets the value of the notionalStepAmount property.- Parameters:
value
- allowed object isBigDecimal
-
getNotionalStepRate
Gets the value of the notionalStepRate property.- Returns:
- possible object is
BigDecimal
-
setNotionalStepRate
Sets the value of the notionalStepRate property.- Parameters:
value
- allowed object isBigDecimal
-
getStepRelativeTo
Gets the value of the stepRelativeTo property.- Returns:
- possible object is
StepRelativeToEnum
-
setStepRelativeTo
Sets the value of the stepRelativeTo property.- Parameters:
value
- allowed object isStepRelativeToEnum
-