Interface DatumLocation

All Known Subinterfaces:
LocationLookupSettingSpecifier
All Known Implementing Classes:
BasicLocationLookupSettingSpecifier, PriceLocation, SimpleDatumLocation, WeatherLocation

public interface DatumLocation
API for a datum location object.

A location is a standardized reference to some place or some source of information, for example a weather location, a price location, etc.

Version:
1.0
Author:
matt
  • Field Details

  • Method Details

    • getLocationId

      Long getLocationId()
      Get a unique ID of this location.
      Returns:
      the location ID
    • getLocationName

      String getLocationName()
      Get a name for this location.
      Returns:
      the location name
    • getSourceId

      String getSourceId()
      Get a unique ID of the source of this location.
      Returns:
      the source ID
    • getSourceName

      String getSourceName()
      Get the name of the source of this location.
      Returns:
      the source name
    • getMetadata

      net.solarnetwork.domain.datum.GeneralDatumMetadata getMetadata()
      Get metadata about the location.
      Returns:
      metadata