Package energy.eddie.api.agnostic.data.needs

Record Class ValidatedHistoricalDataDataNeedResult

java.lang.Object
java.lang.Record
energy.eddie.api.agnostic.data.needs.ValidatedHistoricalDataDataNeedResult
Record Components:
granularities - The calculated granularities, which is the intersection of the needed granularities by the data-need and the supported granularities of the region-connector.
permissionTimeframe - The timeframe of the permission request. States a start date from which data can be requested and an end date until data can be requested.
energyTimeframe - The start and end date of the requested data.
All Implemented Interfaces:
DataNeedCalculationResult
public record ValidatedHistoricalDataDataNeedResult(List<Granularity> granularities, Timeframe permissionTimeframe, Timeframe energyTimeframe) extends Record implements DataNeedCalculationResult
Result type for the calculation of validated historical data data-needs.

  • Constructor Details

    • ValidatedHistoricalDataDataNeedResult

      public ValidatedHistoricalDataDataNeedResult(List<Granularity> granularities, Timeframe permissionTimeframe, Timeframe energyTimeframe)
      Creates an instance of a ValidatedHistoricalDataDataNeedResult record class.
      Parameters:
      granularities - the value for the granularities record component
      permissionTimeframe - the value for the permissionTimeframe record component
      energyTimeframe - the value for the energyTimeframe record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • granularities

      public List<Granularity> granularities()
      Returns the value of the granularities record component.
      Returns:
      the value of the granularities record component

    • permissionTimeframe

      public Timeframe permissionTimeframe()
      Returns the value of the permissionTimeframe record component.
      Returns:
      the value of the permissionTimeframe record component

    • energyTimeframe

      public Timeframe energyTimeframe()
      Returns the value of the energyTimeframe record component.
      Returns:
      the value of the energyTimeframe record component