Open topic with navigation

com.hp.lft.sdk

## Class DateRange

- java.lang.Object
- - com.hp.lft.sdk.DateRange

-     public class DateRange
      extends java.lang.Object

  A range of dates used for month calendar controls that support multi-selection.

- - ### Constructor Summary

    Constructor and Description
    `DateRange(java.util.Date startDate, java.util.Date endDate)` Initializes a new instance of the DateRange class.

  - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `static DateRange` | `dateRangeAsSingleDate(java.util.Date date)` Returns a DateRange instance initialized with an end date equal to the start date.
    `java.util.Date` | `getEndDate()` Returns the end date of the range.
    `java.util.Date` | `getStartDate()` Returns the start date of the range.
    `void` | `setEndDate(java.util.Date endDate)` Sets the end date of the range.
    `void` | `setStartDate(java.util.Date startDate)` Sets the start date of the range.
    `java.lang.String` | `toString()`

    - ### Methods inherited from class java.lang.Object

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

- - ### Constructor Detail

    - #### DateRange

          public DateRange(java.util.Date startDate,
                           java.util.Date endDate)
                    throws GeneralLeanFtException

      Initializes a new instance of the DateRange class.
      Parameters:
        `startDate` - the start date of the range.
        `endDate` - the end date of the range.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution. Note: if either startDate or endDate are null, then the non-null value provided will be used also for the missing date.

  - ### Method Detail

    - #### getStartDate

          public java.util.Date getStartDate()

      Returns the start date of the range.
      Returns:
        the start date of the range.

    - #### setStartDate

          public void setStartDate(java.util.Date startDate)
                            throws GeneralLeanFtException

      Sets the start date of the range.
      Parameters:
        `startDate` - the start date of the range.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### getEndDate

          public java.util.Date getEndDate()

      Returns the end date of the range.
      Returns:
        the end date of the range.

    - #### setEndDate

          public void setEndDate(java.util.Date endDate)
                          throws GeneralLeanFtException

      Sets the end date of the range.
      Parameters:
        `endDate` - the end date of the range.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### dateRangeAsSingleDate

          public static DateRange dateRangeAsSingleDate(java.util.Date date)
                                                 throws GeneralLeanFtException

      Returns a DateRange instance initialized with an end date equal to the start date.
      Parameters:
        `date` - date that represents both the start and end date of the range.
      Returns:
        a DateRange instance initialized with an end date equal to the start date.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### toString

          public java.lang.String toString()

      Overrides:
        `toString` in class `java.lang.Object`