Package energy.eddie.regionconnector.shared.services.data.needs.calculation.strategies

Interface EnergyDataTimeframeStrategy

All Known Implementing Classes:

AiidaEnergyDataTimeframeStrategy, DefaultEnergyDataTimeframeStrategy, EdaStrategy, FluviusEnergyTimeframeStrategy

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface EnergyDataTimeframeStrategy

Method Summary

Modifier and Type	Method	Description
Timeframe	energyDataTimeframe(DataNeed dataNeed, ZonedDateTime referenceDateTime)	Creates a timeframe for in which the energy data should lie in.

Method Details

energyDataTimeframe

@Nullable
Timeframe energyDataTimeframe(DataNeed dataNeed,
 ZonedDateTime referenceDateTime)
                       throws UnsupportedDataNeedException

Creates a timeframe for in which the energy data should lie in. Can return null if the provided data need does not require an energy data timeframe.

Parameters:

dataNeed - The data need is the basis for the timeframe calculation

referenceDateTime - The reference datetime has to be used to calculate the start and end date. Usually the created datetime of the PermissionRequest.

Returns:

The timeframe of the energy data.

Throws:

UnsupportedDataNeedException - if the strategy does not support the data need.