Open topic with navigation

com.hp.lft.sdk

## Interface CalendarBase

- All Known Subinterfaces:
    Calendar, Calendar

      public interface CalendarBase

  Base interface for Calendar test objects.

- - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `java.util.Date` | `getDate()` Returns the date associated with this calendar.
    `DateRange` | `getDateRange()` Returns the range of dates selected in this calendar. Notes: - Supported only for month calendar controls in multi-selection mode.
    `java.sql.Time` | `getTime()` Returns the time associated with this calendar.
    `boolean` | `isRangeSelected()` Indicates whether a range of dates is currently selected in this calendar.
    `void` | `setDate(java.util.Date date)` Sets the date of this calendar.
    `void` | `setDateRange(java.util.Date startDate, java.util.Date endDate)` Sets the specified date range with separate start and end Date values.
    `void` | `setDateRange(DateRange dateRange)` Sets the specified date range using a DateRange value.
    `void` | `setTime(java.sql.Time time)` Sets the time of this calendar.

- - ### Method Detail

    - #### getDate

          java.util.Date getDate()
                          throws GeneralLeanFtException

      Returns the date associated with this calendar.
      Note: If a date range is selected, returns the start date of the range.
      Returns:
        the date associated with this calendar.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### setDate

          void setDate(java.util.Date date)
                throws GeneralLeanFtException

      Sets the date of this calendar.
      Parameters:
        `date` - the date to set.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### getDateRange

                                                      DateRange getDateRange()
                          throws GeneralLeanFtException

      Returns the range of dates selected in this calendar.
      Notes:
      - Supported only for month calendar controls in multi-selection mode.
      - If a single date is selected, both DateRange.getStartDate and DateRange.getEndDate return the selected date.
      Returns:
        a range of dates.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### setDateRange

          void setDateRange(DateRange dateRange)
                     throws GeneralLeanFtException

      Sets the specified date range using a DateRange value. Note: Supported only for month calendar controls in multi-selection mode.
      Parameters:
        `dateRange` - the date range to set.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### setDateRange

          void setDateRange(java.util.Date startDate,
                            java.util.Date endDate)
                     throws GeneralLeanFtException

      Sets the specified date range with separate start and end Date values.
      Parameters:
        `startDate` - the start date of the range.
        `endDate` - the end date of the range.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### isRangeSelected

          boolean isRangeSelected()
                           throws GeneralLeanFtException

      Indicates whether a range of dates is currently selected in this calendar.
      Returns:
        true, if a range of dates is currently selected in this calendar.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### getTime

          java.sql.Time getTime()
                         throws GeneralLeanFtException

      Returns the time associated with this calendar.
      Returns:
        the time associated with this calendar.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.

    - #### setTime

          void setTime(java.sql.Time time)
                throws GeneralLeanFtException

      Sets the time of this calendar.
      Parameters:
        `time` - the time to set.
      Throws:
        `GeneralLeanFtException` - if an error occurs during execution.