Package net.solarnetwork.central.common.dao

Interface LocationCriteria

All Known Subinterfaces:
LocationRequestCriteria
All Known Implementing Classes:
BasicCoreCriteria, BasicLocationRequestCriteria, BasicUserEventFilter, BasicUserMetadataFilter
public interface LocationCriteria
Search criteria for location related data.
Since:
2.8

  • Method Summary

    Modifier and Type
    Method
    Description
    net.solarnetwork.domain.Location
    getLocation()
    Get a location to use as geographic criteria.
    Long
    getLocationId()
    Get the first location ID.
    Long[]
    getLocationIds()
    Get an array of location IDs.
    default boolean
    hasLocationCriteria()
    Test if a Location is present and any of its properties have a non-empty value.

  • Method Details

    • getLocationId

      Long getLocationId()
      Get the first location ID.

      This returns the first available location ID from the getLocationIds() array, or null if not available.

      Returns:
      the location ID, or null if not available

    • getLocationIds

      Long[] getLocationIds()
      Get an array of location IDs.
      Returns:
      array of locations IDs (may be null)

    • getLocation

      net.solarnetwork.domain.Location getLocation()
      Get a location to use as geographic criteria.
      Returns:
      the location whose properties represent geographic search criteria

    • hasLocationCriteria

      default boolean hasLocationCriteria()
      Test if a Location is present and any of its properties have a non-empty value.
      Returns:
      true if some property is not empty on the location