Package net.finmath.smartcontract.product.xml

Class CalculationPeriodDates

java.lang.Object
net.finmath.smartcontract.product.xml.CalculationPeriodDates
public class CalculationPeriodDates extends Object
A type defining the parameters used to generate the calculation period dates schedule, including the specification of any initial or final stub calculation periods. A calculation perod schedule consists of an optional initial stub calculation period, one or more regular calculation periods and an optional final stub calculation period. In the absence of any initial or final stub calculation periods, the regular part of the calculation period schedule is assumed to be between the effective date and the termination date. No implicit stubs are allowed, i.e. stubs must be explicitly specified using an appropriate combination of firstPeriodStateDate, firstRegularPeriodStartDate and lastRegularPeriodEndDate.

Java class for CalculationPeriodDates complex type.

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

 <complexType name="CalculationPeriodDates">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <choice>
           <element name="effectiveDate" type="{http://www.fpml.org/FpML-5/confirmation}AdjustableDate"/>
           <element name="relativeEffectiveDate" type="{http://www.fpml.org/FpML-5/confirmation}AdjustedRelativeDateOffset"/>
         </choice>
         <choice>
           <element name="terminationDate" type="{http://www.fpml.org/FpML-5/confirmation}AdjustableDate"/>
           <element name="relativeTerminationDate" type="{http://www.fpml.org/FpML-5/confirmation}RelativeDateOffset"/>
         </choice>
         <element name="calculationPeriodDatesAdjustments" type="{http://www.fpml.org/FpML-5/confirmation}BusinessDayAdjustments"/>
         <element name="firstPeriodStartDate" type="{http://www.fpml.org/FpML-5/confirmation}AdjustableDate" minOccurs="0"/>
         <element name="firstRegularPeriodStartDate" type="{http://www.w3.org/2001/XMLSchema}date" minOccurs="0"/>
         <element name="firstCompoundingPeriodEndDate" type="{http://www.w3.org/2001/XMLSchema}date" minOccurs="0"/>
         <element name="lastRegularPeriodEndDate" type="{http://www.w3.org/2001/XMLSchema}date" minOccurs="0"/>
         <element name="stubPeriodType" type="{http://www.fpml.org/FpML-5/confirmation}StubPeriodTypeEnum" minOccurs="0"/>
         <element name="calculationPeriodFrequency" type="{http://www.fpml.org/FpML-5/confirmation}CalculationPeriodFrequency"/>
       </sequence>
       <attribute name="id" use="required" type="{http://www.w3.org/2001/XMLSchema}ID" />
     </restriction>
   </complexContent>
 </complexType>

  • Field Details

  • Constructor Details

    • CalculationPeriodDates

      public CalculationPeriodDates()

  • Method Details

    • getEffectiveDate

      public AdjustableDate getEffectiveDate()
      Gets the value of the effectiveDate property.
      Returns:
      possible object is AdjustableDate

    • setEffectiveDate

      public void setEffectiveDate​(AdjustableDate value)
      Sets the value of the effectiveDate property.
      Parameters:
      value - allowed object is AdjustableDate

    • getRelativeEffectiveDate

      public AdjustedRelativeDateOffset getRelativeEffectiveDate()
      Gets the value of the relativeEffectiveDate property.
      Returns:
      possible object is AdjustedRelativeDateOffset

    • setRelativeEffectiveDate

      public void setRelativeEffectiveDate​(AdjustedRelativeDateOffset value)
      Sets the value of the relativeEffectiveDate property.
      Parameters:
      value - allowed object is AdjustedRelativeDateOffset

    • getTerminationDate

      public AdjustableDate getTerminationDate()
      Gets the value of the terminationDate property.
      Returns:
      possible object is AdjustableDate

    • setTerminationDate

      public void setTerminationDate​(AdjustableDate value)
      Sets the value of the terminationDate property.
      Parameters:
      value - allowed object is AdjustableDate

    • getRelativeTerminationDate

      public RelativeDateOffset getRelativeTerminationDate()
      Gets the value of the relativeTerminationDate property.
      Returns:
      possible object is RelativeDateOffset

    • setRelativeTerminationDate

      public void setRelativeTerminationDate​(RelativeDateOffset value)
      Sets the value of the relativeTerminationDate property.
      Parameters:
      value - allowed object is RelativeDateOffset

    • getCalculationPeriodDatesAdjustments

      public BusinessDayAdjustments getCalculationPeriodDatesAdjustments()
      Gets the value of the calculationPeriodDatesAdjustments property.
      Returns:
      possible object is BusinessDayAdjustments

    • setCalculationPeriodDatesAdjustments

      public void setCalculationPeriodDatesAdjustments​(BusinessDayAdjustments value)
      Sets the value of the calculationPeriodDatesAdjustments property.
      Parameters:
      value - allowed object is BusinessDayAdjustments

    • getFirstPeriodStartDate

      public AdjustableDate getFirstPeriodStartDate()
      Gets the value of the firstPeriodStartDate property.
      Returns:
      possible object is AdjustableDate

    • setFirstPeriodStartDate

      public void setFirstPeriodStartDate​(AdjustableDate value)
      Sets the value of the firstPeriodStartDate property.
      Parameters:
      value - allowed object is AdjustableDate

    • getFirstRegularPeriodStartDate

      public XMLGregorianCalendar getFirstRegularPeriodStartDate()
      Gets the value of the firstRegularPeriodStartDate property.
      Returns:
      possible object is XMLGregorianCalendar

    • setFirstRegularPeriodStartDate

      public void setFirstRegularPeriodStartDate​(XMLGregorianCalendar value)
      Sets the value of the firstRegularPeriodStartDate property.
      Parameters:
      value - allowed object is XMLGregorianCalendar

    • getFirstCompoundingPeriodEndDate

      public XMLGregorianCalendar getFirstCompoundingPeriodEndDate()
      Gets the value of the firstCompoundingPeriodEndDate property.
      Returns:
      possible object is XMLGregorianCalendar

    • setFirstCompoundingPeriodEndDate

      public void setFirstCompoundingPeriodEndDate​(XMLGregorianCalendar value)
      Sets the value of the firstCompoundingPeriodEndDate property.
      Parameters:
      value - allowed object is XMLGregorianCalendar

    • getLastRegularPeriodEndDate

      public XMLGregorianCalendar getLastRegularPeriodEndDate()
      Gets the value of the lastRegularPeriodEndDate property.
      Returns:
      possible object is XMLGregorianCalendar

    • setLastRegularPeriodEndDate

      public void setLastRegularPeriodEndDate​(XMLGregorianCalendar value)
      Sets the value of the lastRegularPeriodEndDate property.
      Parameters:
      value - allowed object is XMLGregorianCalendar

    • getStubPeriodType

      public StubPeriodTypeEnum getStubPeriodType()
      Gets the value of the stubPeriodType property.
      Returns:
      possible object is StubPeriodTypeEnum

    • setStubPeriodType

      public void setStubPeriodType​(StubPeriodTypeEnum value)
      Sets the value of the stubPeriodType property.
      Parameters:
      value - allowed object is StubPeriodTypeEnum

    • getCalculationPeriodFrequency

      public CalculationPeriodFrequency getCalculationPeriodFrequency()
      Gets the value of the calculationPeriodFrequency property.
      Returns:
      possible object is CalculationPeriodFrequency

    • setCalculationPeriodFrequency

      public void setCalculationPeriodFrequency​(CalculationPeriodFrequency value)
      Sets the value of the calculationPeriodFrequency property.
      Parameters:
      value - allowed object is CalculationPeriodFrequency

    • getId

      public String getId()
      Gets the value of the id property.
      Returns:
      possible object is String

    • setId

      public void setId​(String value)
      Sets the value of the id property.
      Parameters:
      value - allowed object is String