de.aristaflow.adept2.model.activitymodel

Interface ConfigurationSet

All Superinterfaces:

AbstractConfigurationSet, PluginDataContainer, UserAttributeContainer

public interface ConfigurationSet
extends AbstractConfigurationSet

A ConfigurationSet is a collection of configurations, configuration descriptions as well as a few other attributes. This allows for an easy way to provide common configurations for otherwise independent activity template definitions.
A configuration set is located between Operations and ActivityTemplateDefinitions. They group arbitrary operations (and therefore also the corresponding executable component descriptions). These are the parent entities of the configuration set in the activity model. A configuration set has child entities which are activity template definitions. To preserve the hierarchical structure of the activity model, an activity template definition always has an operation as parent but it may also have a configuration set as direct parent and the corresponding operation as indirect parent. But an activity template definition may not change its parents especially not its direct parent. That means, an existing activity template definition, may neither change the configuration set nor it may become child of a configuration set in case it already is a direct child of an operation.

Being that way integrated into the activity model, a configuration set may override configurations, configuration descriptions, test configurations, parameter templates and staff assignment rules of all of its operations. This in turn may then be overridden by the corresponding activity template definitions again.
To enhance the power of configuration sets, overriding may be more specific: it can apply to all activity template definitions that are children of this configuration set, to the activity template definitions of a particular executable component description or just the activity template definitions that are based on a designated operation. Therefore the inheritance overriding in the activity model is as follows for a specific attribute (if the attribute is present in all entities):

• executable component description
• operation
• configuration set: attributes that apply to the whole configuration set
• configuration set: attributes that apply to the executable component description
• configuration set: attributes that apply to the operation
• activity template definition

Note that staff assignment rules may only be applied to a whole configuration set or to operations but not to all activity template definitions of a configuration set that are based on a particular executable component description.

A configuration that applies to the whole configuration set is based upon a corresponding configuration description. This must not be arbitrary but be itself based upon the configuration descriptions of the operations and executable component descriptions of this configuration set. Only entries of these configuration descriptions may be incurred that do not conflict. A conflict will occur if two configuration entries have the same name but are of different type. This configuration descriptions applies to all activity template definitions of this configuration set, independent from whether the operation and/or the executable component description of the activity template definition defines the configuration entries.

Since a configuration set groups arbitrary operations there is no notion of a inheriting attribute directly. That is, it can not be determined, whether an attribute of a configuration set inherits from a parent entity or not (since the parent entity need not be unique). Therefore a configuration set lacks methods for checking inheritance and removing own values. This also prevents explicitly setting null values to override a non-null value in a parent entity.

Configurations in this configuration set need to conform to a configuration description. However, the used configuration description may be a merged one. A configuration that applies to the whole configuration set, needs an entry in the configuration description of the configuration set. A configuration of this configuration set that applies only to an executable component description is based on the merged configuration description of the configuration set (the global one) and of the corresponding executable component description. Clearly, in case of an operation configuration, the configuration description additionally merges with the one from corresponding operation.
Not all entries of a configuration description needs to have configuration values in this configuration set, but since a configuration set does not relate to a specific operation nor a process, it may not retrieve configuration values from an input parameter or a process configuration.

Test configurations directly override the corresponding "normal" configuration. Therefore they need to conform to the same configuration description. The inheritance in the activity model is as follows:

• configuration of operation
• test configuration of operation
• configuration set: configuration that applies to the whole configuration set
• configuration set: test configuration that applies to the whole configuration set
• configuration set: configuration that applies to the executable component description
• configuration set: test configuration that applies to the executable component description
• configuration set: configuration that applies to the operation
• configuration set: test configuration that applies to the operation
• configuration of activity template definition
• test configuration of activity template definition

Besides the other entities of the activity model, a configuration set does not support overriding its configurations at runtime. Overriding at runtime takes place with configuration namespaces which are quite similar to configuration sets. They are located above ExecutableComponentDescriptions, Operations and ActivityTemplateDefinitions. The decoupling from configuration sets allows to group activity templates another way than in the activity model (with configuration sets). That is, activity templates of the same configuration set may have different configuration namespaces and vice versa. Note that without a configuration namespace no runtime configuration will be applied.
At runtime there may be global configurations as well as local configurations. The latter overrides the first ones (having the same configuration namespace). Thus the following inheritance applies with:

• configuration for the whole configuration namespace from the global configuration
• configuration for the whole configuration namespace from the local configuration
• configuration for the executable component description from the corresponding namespace from the global configuration
• configuration for the executable component description from the corresponding namespace from the local configuration
• configuration for the operation (fully qualified, including the name of the corresponding executable component description) from the namespace from the global configuration
• configuration for the operation (fully qualified, including the name of the corresponding executable component description) from the namespace from the local configuration
• configuration for the activity (fully qualified, including the name of the corresponding executable component description and operation) from the namespace from the global configuration
• configuration for the activity (fully qualified, including the name of the corresponding executable component description and operation) from the namespace from the local configuration

Author:

Ulrich Kreher

Method Summary

Modifier and Type	Method and Description
InheritedConfiguration	getConfiguration() Gets the configuration for this whole configuration set that corresponds to the configuration description of this configuration set.
InheritedConfiguration	getConfiguration(ExecutableComponentDescription ecd) Gets the configuration for the activity template definitions of this configuration set that are based on the designated executable component description.
InheritedActivityConfiguration	getConfiguration(Operation operation) Gets the configuration for the activity template definitions of this configuration set that are based on the designated operation.
InheritedConfigurationDescription	getConfigurationDescription() Gets the configuration description for this whole configuration set, that is a description of all configuration values that are needed or supported at runtime for all activity templates of this configuration set.
InheritedConfigurationDescription	getConfigurationDescription(ExecutableComponentDescription ecd) Gets the configuration description for the activity template definitions of this configuration set that are based on the designated executable component description.
InheritedConfigurationDescription	getConfigurationDescription(Operation operation) Gets the configuration description for the activity template definitions of this configuration set that are based on the designated operation.
InheritedCollection<java.lang.String,ParameterTemplate>	getParameterTemplates() Gets parameter templates that are defined for all activity template definitions of this configuration set.
InheritedCollection<java.lang.String,ParameterTemplate>	getParameterTemplates(ExecutableComponentDescription ecd) Gets parameter templates that are defined for the activity template definitions of this configuration set that are based on the designated executable component description.
InheritedCollection<java.lang.String,ParameterTemplate>	getParameterTemplates(Operation operation) Gets parameter templates that are defined for the activity template definitions of this configuration set that are based on the designated operation.
java.lang.String	getStaffAssignmentRule(Operation operation) Gets the staff assignment rule that is proposed by the administrator of the activity model for the activity template definitions of this configuration set that are based on the designated operation.
StorageConfigurationSet	getStorageCS() Gets the object that allows to easily store the data of this ConfigurationSet.
InheritedConfiguration	getTestConfiguration() Gets the test configuration for this whole configuration set that corresponds to the configuration description of this configuration set.
InheritedConfiguration	getTestConfiguration(ExecutableComponentDescription ecd) Gets the test configuration for the activity template definitions of this configuration set that are based on the designated executable component description.
InheritedActivityConfiguration	getTestConfiguration(Operation operation) Gets the test configuration for the activity template definitions of this configuration set that are based on the designated operation.
void	setConfiguration(InheritedActivityConfiguration configuration, java.lang.String ecName, java.lang.String operationName) Sets the configuration for the activity template definitions of this configuration set that are based on the designated operation.
void	setConfiguration(InheritedConfiguration configuration) Sets the configuration for this whole configuration set.
void	setConfiguration(InheritedConfiguration configuration, java.lang.String ecName) Sets the configuration for the activity template definitions of this configuration set that are based on the designated executable component description.
void	setConfigurationDescription(InheritedConfigurationDescription description) Sets the configuration description for this whole configuration set, that is a description of all configuration values that are needed or supported at runtime for all activity templates of this configuration set.
void	setConfigurationDescription(InheritedConfigurationDescription description, java.lang.String ecName) Sets the configuration description for the activity template definitions of this configuration set that are based on the designated executable.
void	setConfigurationDescription(InheritedConfigurationDescription description, java.lang.String ecName, java.lang.String operationName) Sets the configuration description for the activity template definitions of this configuration set that are based on the designated operation.
void	setParameterTemplates(InheritedCollection<java.lang.String,ParameterTemplate> parameterTemplates) Sets parameter templates that are defined for all activity template definitions of this configuration set.
void	setParameterTemplates(InheritedCollection<java.lang.String,ParameterTemplate> parameterTemplates, java.lang.String ecName) Sets parameter templates that are defined for the activity template definitions of this configuration set that are based on the designated executable component description.
void	setParameterTemplates(InheritedCollection<java.lang.String,ParameterTemplate> parameterTemplates, java.lang.String ecName, java.lang.String operationName) Sets parameter templates that are defined for the activity template definitions of this configuration set that are based on the designated operation.
void	setTestConfiguration(InheritedActivityConfiguration testConfiguration, java.lang.String ecName, java.lang.String operationName) Sets the test configuration for the activity template definitions of this configuration set that are based on the designated operation.
void	setTestConfiguration(InheritedConfiguration testConfiguration) Sets the test configuration for this whole configuration set.
void	setTestConfiguration(InheritedConfiguration testConfiguration, java.lang.String ecName) Sets the test configuration for the activity template definitions of this configuration set that are based on the designated executable component description.

Methods inherited from interface de.aristaflow.adept2.model.activitymodel.AbstractConfigurationSet

addOperation, getDeveloperDescription, getName, getOperationNames, getRevision, getStaffAssignmentRule, getState, removeOperation, setDeveloperDescription, setName, setStaffAssignmentRule, setStaffAssignmentRule

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

getPluginData, getPluginDatas, getSupportedPlugins

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

getUserAttributes, getUserAttributeValue, removeUserAttributeValue, setUserAttributeValue

Method Detail

getConfigurationDescription

InheritedConfigurationDescription getConfigurationDescription()

Gets the configuration description for this whole configuration set, that is a description of all configuration values that are needed or supported at runtime for all activity templates of this configuration set. This is based on the configuration description of all operations of this configuration sets as well as their executable component descriptions. It does not contain any conflicting entries, that are entries of the same name that are of different type defined in different configuration descriptions. These configuration entries may be subject of overriding, that is, their description, their restrictions and their optional state may be changed.
Therefore this configuration description may contain copies and override some or all of the entries of its operations and executable component descriptions. However, when merging an activity model branch, such a configuration description will override and merge with the appropriate configuration description from the operation and the executable component description from this activity model branch.

Returns:

The description for the configuration values of this configuration set, that is, the name of the configuration entries, their type and whether they are mandatory. This applies to all activity template definitions of this configuration set.

getConfigurationDescription

InheritedConfigurationDescription getConfigurationDescription(ExecutableComponentDescription ecd)

Gets the configuration description for the activity template definitions of this configuration set that are based on the designated executable component description. That is a description of all configuration values that are needed or supported at runtime for activity templates of this configuration set. This also provides whether a configuration value is mandatory and its type. The designated operation has to be in this configuration set!
This configuration description is merged with the configuration description of the designated executable component description as well as the global configuration description for this configuration set.

Parameters:

ecd - The executable component description of which to retrieve the merged configuration description of this configuration set.

Returns:

The merged description for the configuration values of this configuration set, that is, the name of the configuration entries, their type and whether they are mandatory. This applies only to activity template definitions based on the designated executable component description.

getConfigurationDescription

InheritedConfigurationDescription getConfigurationDescription(Operation operation)

Gets the configuration description for the activity template definitions of this configuration set that are based on the designated operation. That is a description of all configuration values that are needed or supported at runtime for activity templates of this configuration set. This also provides whether a configuration value is mandatory and its type. The designated operation has to be in this configuration set!
This configuration description is merged with the configuration description of the designated operation as well as the global and the ECD-specific configuration description for this configuration set.

Parameters:

operation - The operation of which to retrieve the merged configuration description of this configuration set.

Returns:

The merged description for the configuration values of this configuration set, that is, the name of the configuration entries, their type and whether they are mandatory. This applies only to activity template definitions based on the designated operation.

getConfiguration

InheritedConfiguration getConfiguration()

Gets the configuration for this whole configuration set that corresponds to the configuration description of this configuration set. This configuration may be overridden in the corresponding activity template definitions (unless fixed) and not all configuration values need to be provided yet.

Configurations values of configuration sets may not be provided via input parameters or from a process configuration! However, the corresponding activity template definitions may override this and use an input parameter or the process configuration.

Returns:

The configuration values set for this configuration set based on the configuration description. This does not necessarily contain all values since they can still be set when modelling. This applies to all activity template definitions of this configuration set.

getConfiguration

InheritedConfiguration getConfiguration(ExecutableComponentDescription ecd)

Gets the configuration for the activity template definitions of this configuration set that are based on the designated executable component description. The configuration corresponds to the merged configuration description of this configuration set for the designated executable component description. This may be overridden in the corresponding activity template definitions (unless fixed) and not all configuration values need to be provided yet. An operation of the designated executable component description has to be in this configuration set!

Configurations values of configuration sets may not be provided via input parameters or from a process configuration! However, the corresponding activity template definitions may override this and use an input parameter or the process configuration.

This configuration is merged with the configuration of the designated executable component description as well as the global configuration for this configuration set.

Parameters:

ecd - The executable component description of which to retrieve the merged configuration values of this configuration set. An operation of this executable component description has to be in this configuration set.

Returns:

The configuration values set for this configuration set based on the configuration description. This does not necessarily contain all values since they can still be set when modelling. This applies only to activity template definitions based on the designated executable component description.

getConfiguration

InheritedActivityConfiguration getConfiguration(Operation operation)

Gets the configuration for the activity template definitions of this configuration set that are based on the designated operation. The configuration corresponds to the merged configuration description of this configuration set for the designated operation. This may be overridden in the corresponding activity template definitions (unless fixed) and not all configuration values need to be provided yet. The designated operation has to be in this configuration set!

Configurations values of configuration sets may not be provided via input parameters or from a process configuration! However, the corresponding activity template definitions may override this and use an input parameter or the process configuration.

This configuration is merged with the configuration of the designated operation as well as the global and the ECD-specific configuration for this configuration set.

Parameters:

operation - The operation of which to retrieve the merged configuration description of this configuration set. This operation has to be in this configuration set.

Returns:

The configuration values set for this configuration set based on the configuration description. This does not necessarily contain all values since they can still be set when modelling. This applies only to activity template definitions based on the designated operation.

getTestConfiguration

InheritedConfiguration getTestConfiguration()

Gets the test configuration for this whole configuration set that corresponds to the configuration description of this configuration set. These configuration values only apply when executing in test mode, that is the corresponding operation is provided this configuration instead of the normal configuration. This test configuration may be overridden in the corresponding activity template definitions (unless fixed) and not all configuration values need to be provided yet.

Configurations values of configuration sets may not be provided via input parameters or from a process configuration! However, the corresponding activity template definitions may override this and use an input parameter or the process configuration.

This test configuration is merged with the normal global configuration for this configuration set.

Returns:

The configuration values set for the test mode of the activity template definitions of this configuration set based on the configuration description. This does not necessarily contain all values since they can still be set when modelling. This applies to all activity template definitions of this configuration set.

getTestConfiguration

InheritedConfiguration getTestConfiguration(ExecutableComponentDescription ecd)

Gets the test configuration for the activity template definitions of this configuration set that are based on the designated executable component description. The configuration corresponds to the merged configuration description of this configuration set for the designated executable component description. These configuration values only apply when executing in test mode, that is the corresponding operation is provided this configuration instead of the normal configuration. This test configuration may be overridden in the corresponding activity template definitions (unless fixed) and not all configuration values need to be provided yet. An operation of the designated executable component description has to be in this configuration set!

Configurations values of configuration sets may not be provided via input parameters or from a process configuration! However, the corresponding activity template definitions may override this and use an input parameter or the process configuration.

This test configuration is merged appropriately with the test configurations and the normal configurations of the corresponding parent entities (see interface description above).

Parameters:

ecd - The executable component description of which to retrieve the merged test configuration values of this configuration set. An operation of this executable component description has to be in this configuration set.

Returns:

The test configuration values set for this configuration set based on the configuration description. This does not necessarily contain all values since they can still be set when modelling. This applies only to activity template definitions based on the designated executable component description.

getTestConfiguration

InheritedActivityConfiguration getTestConfiguration(Operation operation)

Gets the test configuration for the activity template definitions of this configuration set that are based on the designated operation. The configuration corresponds to the merged configuration description of this configuration set for the designated operation. These configuration values only apply when executing in test mode, that is the corresponding operation is provided this configuration instead of the normal configuration. This test configuration may be overridden in the corresponding activity template definitions (unless fixed) and not all configuration values need to be provided yet. The designated operation has to be in this configuration set!

Configurations values of configuration sets may not be provided via input parameters or from a process configuration! The designated activity configuration only allows to override such a provision. However, the corresponding activity template definitions may override this and use an input parameter or the process configuration.

This test configuration is merged appropriately with the test configurations and the normal configurations of the corresponding parent entities (see interface description above).

Parameters:

operation - The operation of which to retrieve the merged test configuration values of this configuration set. This operation has to be in this configuration set.

Returns:

The test configuration values set for this configuration set based on the configuration description. This does not necessarily contain all values since they can still be set when modelling. This applies only to activity template definitions based on the designated operation.

getParameterTemplates

InheritedCollection<java.lang.String,ParameterTemplate> getParameterTemplates()

Gets parameter templates that are defined for all activity template definitions of this configuration set. This allows to simplify the creation of parameters for activity template definitions and activity templates for operations with a non-fixed interfaces (generic interfaces).

These templates need not be used at all when creating parameters. If a component needs to ensure that only these templates are used, an appropriate check needs to be provided that verifies the created parameters.

The collection of parameter templates is merged with the collection of parameter templates of the corresponding parent entities.

Returns:

Templates for parameters (mapped from parameter template name to the corresponding parameter template) that may be added to all the activity template definitions of this configuration set.

getParameterTemplates

InheritedCollection<java.lang.String,ParameterTemplate> getParameterTemplates(ExecutableComponentDescription ecd)

Gets parameter templates that are defined for the activity template definitions of this configuration set that are based on the designated executable component description. This allows to simplify the creation of parameters for activity template definitions and activity templates for operations with a non-fixed interfaces (generic interfaces).

These templates need not be used at all when creating parameters. If a component needs to ensure that only these templates are used, an appropriate check needs to be provided that verifies the created parameters.

The collection of parameter templates is merged with the collection of parameter templates of the designated executable component description as well as the global collection of parameter templates for this configuration set.

Parameters:

ecd - The executable component description of which to retrieve parameter templates of this configuration set.

Returns:

Templates for parameters (mapped from parameter template name to the corresponding parameter template) that may be added to the activity template definitions of this configuration set based on the designated executable component description.

getParameterTemplates

InheritedCollection<java.lang.String,ParameterTemplate> getParameterTemplates(Operation operation)

Gets parameter templates that are defined for the activity template definitions of this configuration set that are based on the designated operation. This allows to simplify the creation of parameters for activity template definitions and activity templates for operations with a non-fixed interfaces (generic interfaces).

These templates need not be used at all when creating parameters. If a component needs to ensure that only these templates are used, an appropriate check needs to be provided that verifies the created parameters.

The collection of parameter templates is merged with the collection of parameter templates of the designated operation as well as the global and the ECD-specific collection of parameter templates for this configuration set.

Parameters:

operation - The operation of which to retrieve parameter templates of this configuration set.

Returns:

Templates for parameters (mapped from parameter template name to the corresponding parameter template) that may be added to the activity template definitions of this configuration set based on the designated operation.

getStaffAssignmentRule

java.lang.String getStaffAssignmentRule(Operation operation)

Gets the staff assignment rule that is proposed by the administrator of the activity model for the activity template definitions of this configuration set that are based on the designated operation. However, the process modeler can deviate from this.

The staff assignment rule is merged with the staff assignment rule of the designated operation as well as the global staff assignment rule for this configuration set.

Parameters:

operation - The operation of which the activity template definitions of this configuration set are provided the returned staff assignment rule.

Returns:

The staff assignment rule that is proposed by the administrator of the activity model for the activity template definitions based on the designated operation.

getStorageCS

StorageConfigurationSet getStorageCS()

Gets the object that allows to easily store the data of this ConfigurationSet. This provides the data without merging it before, that is, these are only the differences with respect to the parent entities.

The returned object is for storing only! You should not rely on it to retrieve unmerged attribute values! If you need these, you will have to use appropriate tool methods or "unmerge" them yourself.

Returns:

The object for storing this ConfigurationSet by just providing the differences with respect to the parent entities. That is no attribute value is merged with the corresponding parent attribute.

setConfigurationDescription

void setConfigurationDescription(InheritedConfigurationDescription description)

Sets the configuration description for this whole configuration set, that is a description of all configuration values that are needed or supported at runtime for all activity templates of this configuration set. This also provides whether a configuration value is mandatory and its type.

The designated configuration description has to be based on the configuration descriptions of the operations and executable component descriptions of this configuration set. It must not contain any conflicting entries, that are entries of the same name that are of different type defined in different configuration descriptions. However, these configuration entries may be subject of overriding, that is, their description, their restrictions and their optional state may be changed.

The configuration description has to be set as a whole; to add or modify single entries, retrieve the complete description, add or modify the entry by respecting the constraints and provide the complete description again to this method. Use null to remove it.

Parameters:

description - The description for the configuration values of this configuration set, that is, the name of the configuration entries, their type and whether they are mandatory. Use null to remove the configuration description.

setConfigurationDescription

void setConfigurationDescription(InheritedConfigurationDescription description,
                                 java.lang.String ecName)

Sets the configuration description for the activity template definitions of this configuration set that are based on the designated executable. That is a description of all configuration values that are needed or supported at runtime. This also provides whether a configuration value is mandatory and its type. An operation of the designated executable component description has to be in this configuration set!

The configuration description has to be set as a whole; to add or modify single entries, retrieve the complete description, add or modify the entry and provide the complete description again to this method. Use null to remove it.

The designated configuration description is merged with the configuration description of the corresponding executable component description as well as the global configuration description for this configuration set.

Parameters:

ecName - The name of the executable component description of which to set the overriding configuration description of this configuration set.

description - The description for the configuration values of this configuration set, that is, the name of the configuration entries, their type and whether they are mandatory. This applies only to activity template definitions based on the designated executable component description. Use null to remove the configuration description.

setConfigurationDescription

void setConfigurationDescription(InheritedConfigurationDescription description,
                                 java.lang.String ecName,
                                 java.lang.String operationName)

Sets the configuration description for the activity template definitions of this configuration set that are based on the designated operation. That is a description of all configuration values that are needed or supported at runtime. This also provides whether a configuration value is mandatory and its type. The designated operation has to be in this configuration set!

The configuration description has to be set as a whole; to add or modify single entries, retrieve the complete description, add or modify the entry and provide the complete description again to this method. Use null to remove it.

The designated configuration description is merged with the configuration description of the corresponding operation as well as the global and the ECD-specific configuration description for this configuration set.

Parameters:

ecName - The name of the executable component description which is parent of the operation.

operationName - The name of the operation of which to set the overriding configuration description of this configuration set.

description - The description for the configuration values of this configuration set, that is, the name of the configuration entries, their type and whether they are mandatory. This applies only to activity template definitions based on the designated operation. Use null to remove the configuration description.

setConfiguration

void setConfiguration(InheritedConfiguration configuration)

Sets the configuration for this whole configuration set. The provided configuration has to correspond to the configuration description of this configuration set. That is the values have to have appropriate configuration entries. Not all configuration entries need to have a value yet except the fixed ones. However, configurations values of configuration sets may not be provided via input parameters or from a process configuration!

The configuration has to be set as a whole; to add or modify single values, retrieve the complete configuration, add or modify the value and provide the complete configuration again to this method. Use null to remove the configuration from this configuration set.

Parameters:

configuration - The configuration values set for this configuration set based on the configuration description. This does not necessarily contain all values since they can still be set when modelling. Use null to remove the configuration from this configuration set.

setConfiguration

void setConfiguration(InheritedConfiguration configuration,
                      java.lang.String ecName)

Sets the configuration for the activity template definitions of this configuration set that are based on the designated executable component description. The provided configuration has to correspond to the configuration description of this configuration set for the designated executable component description. That is the values have to have appropriate configuration entries. Not all configuration entries need to have a value yet except the fixed ones. However, configurations values of configuration sets may not be provided via input parameters or from a process configuration!

The configuration has to be set as a whole; to add or modify single values, retrieve the complete configuration, add or modify the value and provide the complete configuration again to this method. Use null to remove the configuration of the designated executable component description from this configuration set.

The designated configuration is merged with the configuration of the corresponding executable component description as well as the global configuration for this configuration set.

Parameters:

ecName - The name of the executable component description of which to set the overriding configuration values of this configuration set. An operation of this executable component description has to be in this configuration set.

configuration - The configuration values set for this configuration set based on the configuration description. This does not necessarily contain all values since they can still be set when modelling. This applies only to activity template definitions based on the designated executable component description. Use null to remove the configuration of the designated executable component description from this configuration set.

setConfiguration

void setConfiguration(InheritedActivityConfiguration configuration,
                      java.lang.String ecName,
                      java.lang.String operationName)

Sets the configuration for the activity template definitions of this configuration set that are based on the designated operation. The provided configuration has to correspond to the configuration description of this configuration set for the designated operation. That is the values have to have appropriate configuration entries. Not all configuration entries need to have a value yet except the fixed ones. However, configurations values of configuration sets may not be provided via input parameters or from a process configuration!

The configuration has to be set as a whole; to add or modify single values, retrieve the complete configuration, add or modify the value and provide the complete configuration again to this method. Use null to remove the configuration of the designated operation from this configuration set.

The designated configuration is merged with the configuration of the corresponding operation as well as the global and the ECD-specific configuration for this configuration set.

Parameters:

ecName - The name of the executable component description which is parent of the operation.

operationName - The name of the operation of which to set the overriding configuration values of this configuration set. This operation has to be in this configuration set.

configuration - The configuration values set for this configuration set based on the configuration description. This does not necessarily contain all values since they can still be set when modelling. This applies only to activity template definitions based on the designated operation. Use null to remove the configuration of the designated operation from this configuration set.

setTestConfiguration

void setTestConfiguration(InheritedConfiguration testConfiguration)

Sets the test configuration for this whole configuration set. The provided configuration has to correspond to the configuration description of this configuration set. That is the values have to have appropriate configuration entries.
These configuration values only apply when executing in test mode, that is the corresponding operation is provided this configuration instead of the normal configuration. This test configuration is merged with the normal configuration. However, configurations values of configuration sets may not be provided via input parameters or from a process configuration! Note that the test configuration allows to override fixed values of the normal configuration.

The configuration has to be set as a whole; to add or modify single values, retrieve the complete configuration, add or modify the value and provide the complete configuration again to this method. Use null to remove it from this configuration set.

Parameters:

testConfiguration - The test configuration values set for this configuration set based on the configuration description. This does not necessarily contain all values since they can still be set when modelling or taken form the normal configuration. Use null to remove the test configuration from this configuration set.

setTestConfiguration

void setTestConfiguration(InheritedConfiguration testConfiguration,
                          java.lang.String ecName)

Sets the test configuration for the activity template definitions of this configuration set that are based on the designated executable component description. The provided configuration has to correspond to the configuration description of this configuration set for the designated executable component description. That is the values have to have appropriate configuration entries.
These configuration values only apply when executing in test mode, that is the corresponding operation is provided this configuration instead of the normal configuration. This test configuration is merged with the normal configuration. However, configurations values of configuration sets may not be provided via input parameters or from a process configuration! Note that the test configuration allows to override fixed values of the normal configuration.

The configuration has to be set as a whole; to add or modify single values, retrieve the complete configuration, add or modify the value and provide the complete configuration again to this method. Use null to remove the test configuration of the designated executable component description from this configuration set.

The designated test configuration is merged appropriately with the test configurations and the normal configurations of the corresponding parent entities (see interface description above).

Parameters:

ecName - The name of the executable component description of which to set the test configuration values of this configuration set. An operation of this executable component description has to be in this configuration set.

testConfiguration - The test configuration values set for this configuration set based on the configuration description. This does not necessarily contain all values since they can still be set when modelling or taken form the normal configuration. This applies only to activity template definitions based on the designated executable component description. Use null to remove the test configuration of the designated executable component description from this configuration set.

setTestConfiguration

void setTestConfiguration(InheritedActivityConfiguration testConfiguration,
                          java.lang.String ecName,
                          java.lang.String operationName)

Sets the test configuration for the activity template definitions of this configuration set that are based on the designated operation. The provided configuration has to correspond to the configuration description of this configuration set for the designated operation. That is the values have to have appropriate configuration entries.
These configuration values only apply when executing in test mode, that is the corresponding operation is provided this configuration instead of the normal configuration. This test configuration is merged with the normal configuration. However, configurations values of configuration sets may not be provided via input parameters or from a process configuration! The designated activity configuration only allows to override such a provision. Note that the test configuration allows to override fixed values of the normal configuration.

The configuration has to be set as a whole; to add or modify single values, retrieve the complete configuration, add or modify the value and provide the complete configuration again to this method. Use null to remove the test configuration of the designated operation from this configuration set.

The designated test configuration is merged appropriately with the test configurations and the normal configurations of the corresponding parent entities (see interface description above).

Parameters:

ecName - The name of the executable component description which is parent of the operation.

operationName - The name of the operation of which to set the test configuration values of this configuration set. This operation has to be in this configuration set.

testConfiguration - The test configuration values set for this configuration set based on the configuration description. This does not necessarily contain all values since they can still be set when modelling or taken form the normal configuration. This applies only to activity template definitions based on the designated operation. Use null to remove the test configuration of the designated operation from this configuration set.

setParameterTemplates

void setParameterTemplates(InheritedCollection<java.lang.String,ParameterTemplate> parameterTemplates)

Sets parameter templates that are defined for all activity template definitions of this configuration set. This allows to simplify the creation of parameters for activity template definitions and activity templates for operations with a non-fixed interfaces (generic interfaces).

When setting the parameter templates the whole collection has to be set, even in case only one parameter template has been modified. Use null for removing all parameter templates for this configuration set.

The designated collection of parameter templates is merged with the collection of parameter templates of the corresponding parent entities.

Parameters:

parameterTemplates - A collection containing all parameter templates that are defined for all activity template descriptions of this configuration set.

setParameterTemplates

void setParameterTemplates(InheritedCollection<java.lang.String,ParameterTemplate> parameterTemplates,
                           java.lang.String ecName)

Sets parameter templates that are defined for the activity template definitions of this configuration set that are based on the designated executable component description. This allows to simplify the creation of parameters for activity template definitions and activity templates for operations with a non-fixed interfaces (generic interfaces).

When setting the parameter templates the whole collection has to be set, even in case only one parameter template has been modified. Use null for removing all parameter templates for the designated executable component description of this configuration set, that is, the parameter templates will be inherited from the executable component description again.

The designated collection of parameter templates is merged with the collection of parameter templates of the designated executable component description as well as the global collection of parameter templates for this configuration set.

Parameters:

parameterTemplates - A collection containing all parameter templates that are defined for the activity template descriptions of this configuration set that are based on the designated executable component description.

ecName - The name of the executable component description of which to set the parameter templates of this configuration set.

setParameterTemplates

void setParameterTemplates(InheritedCollection<java.lang.String,ParameterTemplate> parameterTemplates,
                           java.lang.String ecName,
                           java.lang.String operationName)

Sets parameter templates that are defined for the activity template definitions of this configuration set that are based on the designated operation. This allows to simplify the creation of parameters for activity template definitions and activity templates for operations with a non-fixed interfaces (generic interfaces).

When setting the parameter templates the whole collection has to be set, even in case only one parameter template has been modified. Use null for removing all parameter templates for the designated operation of this configuration set, that is, the parameter templates will be inherited from the operation again.

The designated collection of parameter templates is merged with the collection of parameter templates of the designated operation as well as the global and the ECD-specific collection of parameter templates for this configuration set.

Parameters:

parameterTemplates - A collection containing all parameter templates that are defined for the activity template descriptions of this configuration set that are based on the designated operation.

ecName - The name of the executable component description which is parent of the operation.

operationName - The name of the operation of which to set the parameter templates of this configuration set.