Package io.openems.edge.core.appmanager.dependency.aggregatetask

Interface AggregateTask<T>

All Known Subinterfaces:

ComponentAggregateTask, PersistencePredictorAggregateTask, SchedulerAggregateTask, SchedulerByCentralOrderAggregateTask, StaticIpAggregateTask

All Known Implementing Classes:

ComponentAggregateTaskImpl, PersistencePredictorAggregateTaskImpl, SchedulerAggregateTaskImpl, SchedulerByCentralOrderAggregateTaskImpl, StaticIpAggregateTaskImpl

public interface AggregateTask<T>

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	AggregateTask.AggregateTaskExecuteConstraints

Method Summary

Modifier and Type	Method	Description
void	aggregate(T currentConfiguration, T lastConfiguration)	Aggregates the given instance.
void	create(User user, List<AppConfiguration> otherAppConfigurations)	e.
void	delete(User user, List<AppConfiguration> otherAppConfigurations)	e.
default AggregateTask.AggregateTaskExecuteConstraints	getExecuteConstraints()
String	getGeneralFailMessage(Language l)	Gets a general message for the user if any operations fails.
void	reset()	Resets the task.
void	validate(List<String> errors, AppConfiguration appConfiguration, T config)	Validates the expected configuration.

Method Details

aggregate

void aggregate(T currentConfiguration,
 T lastConfiguration)

Aggregates the given instance.

Parameters:

currentConfiguration - the AppConfiguration of the instance

lastConfiguration - the old configuration of the instance

create

void create(User user,
 List<AppConfiguration> otherAppConfigurations)
     throws OpenemsError.OpenemsNamedException

e. g. creates components that were aggregated by the instances and my also delete unused components.

Parameters:

user - the executing user

otherAppConfigurations - the other existing AppConfigurations

Throws:

OpenemsError.OpenemsNamedException - on error

delete

void delete(User user,
 List<AppConfiguration> otherAppConfigurations)
     throws OpenemsError.OpenemsNamedException

e. g. deletes components that were aggregated.

Parameters:

user - the executing user

otherAppConfigurations - the other existing AppConfigurations

Throws:

OpenemsError.OpenemsNamedException - on error

validate

void validate(List<String> errors,
 AppConfiguration appConfiguration,
 T config)

Validates the expected configuration.

Parameters:

errors - the errors that occur during the validation

appConfiguration - the whole configuration

config - the configuration to validate

getGeneralFailMessage

String getGeneralFailMessage(Language l)

Gets a general message for the user if any operations fails.

Parameters:

l - the Language of the message

Returns:

the error message

getExecuteConstraints

default AggregateTask.AggregateTaskExecuteConstraints getExecuteConstraints()

reset

void reset()

Resets the task.