Package de.aristaflow.adept2.model.common

Interface ActivityConfiguration

All Superinterfaces:

Configuration, Serializable

All Known Subinterfaces:

ChangeableActivityConfiguration, MergingActivityConfiguration

public interface ActivityConfiguration
extends Configuration

In AristaFlow configuration values in the activity model may stem from an input parameter as well as the configuration of the corresponding process. Since these may only be resolved at runtime, null will be returned as value beforehand. The methods of this interface allow to check whether such a value will be resolved at runtime and if so, whether it will stem from an input parameter or a process configuration.

Author:

Ulrich Kreher

Nested Class Summary

Nested classes/interfaces inherited from interface de.aristaflow.adept2.model.common.Configuration

Configuration.ConfigurationIDs

Field Summary

Fields

Modifier and Type	Field	Description
static long	serialVersionUID	Generated ID for serialisation.

Method Summary

Modifier and Type	Method	Description
String	fromInputParameter(String entryName)	Gets the name of the input parameter, the configuration value for the designated entry is provided at runtime.
String	fromProcessConfiguration(String entryName)	Gets the name of the entry of the process configuration, the value for this configuration and the designated entry is provided at runtime.
Set<String>	getAllEntries()	Gets all entry names that have a value different from null in this configuration.

Methods inherited from interface de.aristaflow.adept2.model.common.Configuration

getBoolean, getConfigurationID, getDate, getFloat, getInteger, getString, getUDT, getURI, isFixed

Field Detail

serialVersionUID

static final long serialVersionUID

Generated ID for serialisation.

See Also:

Constant Field Values

Method Detail

fromInputParameter

String fromInputParameter(String entryName)

Gets the name of the input parameter, the configuration value for the designated entry is provided at runtime. This input parameter exists and has the right type in the corresponding activity.
If the specified configuration value is not retrieved from a parameter, this method will return null.

Parameters:

entryName - The name of the entry for which to get the name of the input parameter that provides the configuration value at runtime.

Returns:

The name of the input parameter, the designated configuration value is retrieved of or null in case the configuration value does not stem from an input parameter.

fromProcessConfiguration

String fromProcessConfiguration(String entryName)

Gets the name of the entry of the process configuration, the value for this configuration and the designated entry is provided at runtime. The entry in the process configuration has to exist in the process model and has to have the right type in the corresponding process configuration.
If the specified configuration value is not retrieved from the corresponding process configuration, this method will return null.

Parameters:

entryName - The name of the entry for which to get the name of the configuration key of the process configuration that provides the configuration value at runtime.

Returns:

The name of the entry of the process configuration, the designated configuration value is retrieved of or null in case the configuration value does not stem from the process configuration.

getAllEntries

Set<String> getAllEntries()

Gets all entry names that have a value different from null in this configuration. This entry names also include the values retrieved from an input parameter or a process configuration.

Specified by:

getAllEntries in interface Configuration

Returns:

All entry names that have a value in this configuration or are retrieved from an input parameter or a process configuration.