Package energy.eddie.dataneeds.rules

Interface DataNeedRule.SpecificDataNeedRule<T extends DataNeed>

All Superinterfaces:

DataNeedRule

All Known Implementing Classes:

DataNeedRule.AccountingPointDataNeedRule, DataNeedRule.InboundAiidaDataNeedRule, DataNeedRule.OutboundAiidaDataNeedRule, DataNeedRule.ValidatedHistoricalDataDataNeedRule

Enclosing interface:

DataNeedRule

public static sealed interface DataNeedRule.SpecificDataNeedRule<T extends DataNeed>
extends DataNeedRule
permits DataNeedRule.ValidatedHistoricalDataDataNeedRule, DataNeedRule.AccountingPointDataNeedRule, DataNeedRule.InboundAiidaDataNeedRule, DataNeedRule.OutboundAiidaDataNeedRule

This interface is used by the region connector to specify supported data need types and its configurations. For example, if a region connector supports the ValidatedHistoricalDataDataNeed with a Granularity of PT15M and the EnergyType of ELECTRICITY it could specify it like this: new ValidatedHistoricalDataDataNeedRule(EnergyType.ELECTRICITY, List.of(Granularity.PT15M));

Nested Class Summary

Nested classes/interfaces inherited from interface energy.eddie.dataneeds.rules.DataNeedRule

DataNeedRule.AccountingPointDataNeedRule, DataNeedRule.AllowMultipleDataNeedsRule, DataNeedRule.InboundAiidaDataNeedRule, DataNeedRule.OutboundAiidaDataNeedRule, DataNeedRule.SpecificDataNeedRule<T extends DataNeed>, DataNeedRule.ValidatedHistoricalDataDataNeedRule

Method Summary

Modifier and Type	Method	Description
Class<T>	getDataNeedClass()	Returns the type of data need that is supported by this rule.
String	getType()	This method indicates the type of the DataNeed.

Method Details

getType

String getType()

This method indicates the type of the DataNeed. It returns the simple class name of the DataNeed. Primary used to indicate the type for JSON serialization.

Returns:

the simple class name of the DataNeed.

getDataNeedClass

Class<T> getDataNeedClass()

Returns the type of data need that is supported by this rule.

Returns:

the type of data need that is supported by this rule.