Package net.finmath.smartcontract.product.xml

Class SettlementPeriods

java.lang.Object
net.finmath.smartcontract.product.xml.SettlementPeriods
public class SettlementPeriods extends Object
Specifies a set of Settlement Periods associated with an Electricity Transaction for delivery on an Applicable Day or for a series of Applicable Days.

Java class for SettlementPeriods complex type.

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

 <complexType name="SettlementPeriods">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="duration" type="{http://www.fpml.org/FpML-5/confirmation}SettlementPeriodDurationEnum"/>
         <element name="applicableDay" type="{http://www.fpml.org/FpML-5/confirmation}DayOfWeekExtEnum" maxOccurs="7" minOccurs="0"/>
         <sequence>
           <element name="startTime" type="{http://www.fpml.org/FpML-5/confirmation}OffsetPrevailingTime"/>
           <element name="endTime" type="{http://www.fpml.org/FpML-5/confirmation}OffsetPrevailingTime"/>
           <element name="timeDuration" type="{http://www.w3.org/2001/XMLSchema}time" minOccurs="0"/>
         </sequence>
         <choice minOccurs="0">
           <element name="excludeHolidays" type="{http://www.fpml.org/FpML-5/confirmation}CommodityBusinessCalendar"/>
           <element name="includeHolidays" type="{http://www.fpml.org/FpML-5/confirmation}CommodityBusinessCalendar"/>
         </choice>
       </sequence>
       <attribute name="id" type="{http://www.w3.org/2001/XMLSchema}ID" />
     </restriction>
   </complexContent>
 </complexType>

  • Field Details

  • Constructor Details

    • SettlementPeriods

      public SettlementPeriods()

  • Method Details

    • getDuration

      public String getDuration()
      Gets the value of the duration property.
      Returns:
      possible object is String

    • setDuration

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

    • getApplicableDay

      public List<String> getApplicableDay()
      Gets the value of the applicableDay 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 applicableDay property.

      For example, to add a new item, do as follows: 

          getApplicableDay().add(newItem);

      Objects of the following type(s) are allowed in the list String

    • getStartTime

      public OffsetPrevailingTime getStartTime()
      Gets the value of the startTime property.
      Returns:
      possible object is OffsetPrevailingTime

    • setStartTime

      public void setStartTime​(OffsetPrevailingTime value)
      Sets the value of the startTime property.
      Parameters:
      value - allowed object is OffsetPrevailingTime

    • getEndTime

      public OffsetPrevailingTime getEndTime()
      Gets the value of the endTime property.
      Returns:
      possible object is OffsetPrevailingTime

    • setEndTime

      public void setEndTime​(OffsetPrevailingTime value)
      Sets the value of the endTime property.
      Parameters:
      value - allowed object is OffsetPrevailingTime

    • getTimeDuration

      public XMLGregorianCalendar getTimeDuration()
      Gets the value of the timeDuration property.
      Returns:
      possible object is XMLGregorianCalendar

    • setTimeDuration

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

    • getExcludeHolidays

      public CommodityBusinessCalendar getExcludeHolidays()
      Gets the value of the excludeHolidays property.
      Returns:
      possible object is CommodityBusinessCalendar

    • setExcludeHolidays

      public void setExcludeHolidays​(CommodityBusinessCalendar value)
      Sets the value of the excludeHolidays property.
      Parameters:
      value - allowed object is CommodityBusinessCalendar

    • getIncludeHolidays

      public CommodityBusinessCalendar getIncludeHolidays()
      Gets the value of the includeHolidays property.
      Returns:
      possible object is CommodityBusinessCalendar

    • setIncludeHolidays

      public void setIncludeHolidays​(CommodityBusinessCalendar value)
      Sets the value of the includeHolidays property.
      Parameters:
      value - allowed object is CommodityBusinessCalendar

    • 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