Package net.solarnetwork.dao

Interface LocalDateRangeCriteria

public interface LocalDateRangeCriteria
Search criteria for a local date range.

This API is meant to be used as an alternative to DateRangeCriteria. The local reference is specific to the type of data being queried. For example, when querying nodes, local time might refer to the local times of the nodes.

Since:
1.67
Version:
1.0
Author:
matt

  • Method Summary

    Modifier and Type
    Method
    Description
    LocalDateTime
    getLocalEndDate()
    Get an end date in local time.
    LocalDateTime
    getLocalStartDate()
    Get a start date in local time.
    default boolean
    hasLocalDate()
    Test if the filter has a local start or end date specified.
    default boolean
    hasLocalDateRange()
    Test if the filter has a local date range specified.
    default boolean
    hasLocalEndDate()
    Test if the filter has a local start end specified.
    default boolean
    hasLocalStartDate()
    Test if the filter has a local start date specified.

  • Method Details

    • getLocalStartDate

      LocalDateTime getLocalStartDate()
      Get a start date in local time.

      The in/exclusive nature of this value depends on the context in which the criteria is applied.

      Returns:
      the local start date

    • getLocalEndDate

      LocalDateTime getLocalEndDate()
      Get an end date in local time.

      The in/exclusive nature of this value depends on the context in which the criteria is applied.

      Returns:
      the local end date

    • hasLocalDateRange

      default boolean hasLocalDateRange()
      Test if the filter has a local date range specified.
      Returns:
      true if both a local start and end date are non-null

    • hasLocalDate

      default boolean hasLocalDate()
      Test if the filter has a local start or end date specified.
      Returns:
      true if either a local start or end date are non-null

    • hasLocalStartDate

      default boolean hasLocalStartDate()
      Test if the filter has a local start date specified.
      Returns:
      true if the local start date is non-null

    • hasLocalEndDate

      default boolean hasLocalEndDate()
      Test if the filter has a local start end specified.
      Returns:
      true if the local end date is non-null