public interface StorageConfigurationSet extends AbstractConfigurationSet
ActivityModelParameter which is supported by not inheriting any
attributes from a parent parameter (in contrast to the interface
ActivityModelParameter. Only the information on whether an attribute
is to be inherited is available but not the value itself since this is not
needed for storing. This applies to all methods of this interface,
irrespective of the documentation of the methods.ConfigurationSet| Modifier and Type | Method and Description |
|---|---|
StorageConfiguration |
getConfiguration()
Gets the configuration for this whole configuration set that corresponds to
the configuration description
of this configuration set.
|
StorageConfiguration |
getConfiguration(java.lang.String ecName)
Gets the (unmerged) configuration for the activity template definitions of
this configuration set that are based on the designated executable
component description.
|
StorageActivityConfiguration |
getConfiguration(java.lang.String ecName,
java.lang.String operationName)
Gets the (unmerged) configuration for the activity template definitions of
this configuration set that are based on the designated operation.
|
StorageConfigurationDescription |
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.
|
StorageConfigurationDescription |
getConfigurationDescription(java.lang.String ecName)
Gets the (unmerged) configuration description for the activity template
definitions of this configuration set that are based on the designated
executable component description.
|
StorageConfigurationDescription |
getConfigurationDescription(java.lang.String ecName,
java.lang.String operationName)
Gets the (unmerged) configuration description for the activity template
definitions of this configuration set that are based on the designated
operation.
|
java.util.Map<java.lang.String,StorageParameterTemplate> |
getParameterTemplates()
Gets parameter templates that are defined for all activity template
definitions of this configuration set.
|
java.util.Map<java.lang.String,StorageParameterTemplate> |
getParameterTemplates(java.lang.String ecName)
Gets the (unmerged) parameter templates that are defined for the activity
template definitions of this configuration set that are based on the
designated executable component description.
|
java.util.Map<java.lang.String,StorageParameterTemplate> |
getParameterTemplates(java.lang.String ecName,
java.lang.String operationName)
Gets the (unmerged) 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(java.lang.String ecName,
java.lang.String operationName)
Gets the (non-inherited) 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.
|
StorageConfiguration |
getTestConfiguration()
Gets the test configuration for this whole configuration set that
corresponds to the configuration
description of this configuration set.
|
StorageConfiguration |
getTestConfiguration(java.lang.String ecName)
Gets the (unmerged) test configuration for the activity template
definitions of this configuration set that are based on the designated
executable component description.
|
StorageActivityConfiguration |
getTestConfiguration(java.lang.String ecName,
java.lang.String operationName)
Gets the (unmerged) test configuration for the activity template
definitions of this configuration set that are based on the designated
operation.
|
void |
setConfiguration(StorageActivityConfiguration 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(StorageConfiguration configuration)
Sets the configuration for this whole configuration set.
|
void |
setConfiguration(StorageConfiguration 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(StorageConfigurationDescription 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(StorageConfigurationDescription 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(StorageConfigurationDescription 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(java.util.Map<java.lang.String,StorageParameterTemplate> parameterTemplates)
Sets parameter templates that are defined for all activity template
definitions of this configuration set.
|
void |
setParameterTemplates(java.util.Map<java.lang.String,StorageParameterTemplate> 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(java.util.Map<java.lang.String,StorageParameterTemplate> 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(StorageActivityConfiguration 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(StorageConfiguration testConfiguration)
Sets the test configuration for this whole configuration set.
|
void |
setTestConfiguration(StorageConfiguration testConfiguration,
java.lang.String ecName)
Sets the test configuration for the activity template definitions of this
configuration set.
|
addOperation, getDeveloperDescription, getName, getOperationNames, getRevision, getStaffAssignmentRule, getState, removeOperation, setDeveloperDescription, setName, setStaffAssignmentRule, setStaffAssignmentRulegetPluginData, getPluginDatas, getSupportedPluginsgetUserAttributes, getUserAttributeValue, removeUserAttributeValue, setUserAttributeValueStorageConfigurationDescription getConfigurationDescription()
StorageConfigurationDescription getConfigurationDescription(java.lang.String ecName)
ecName - The name of the executable component description of which to
retrieve the (unmerged) configuration description of this
configuration set.StorageConfigurationDescription getConfigurationDescription(java.lang.String ecName, java.lang.String operationName)
ecName - The name of the executable component description which is
parent of the operation.operationName - The name of the operation of which to retrieve the
(unmerged) configuration description of this configuration set.StorageConfiguration getConfiguration()
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 attribute overrides and merges with the corresponding parent configurations. That is, the attribute contains only new entries and entries that are changed with respect to the inherited ones whereas the entries are identified by their name.
StorageConfiguration getConfiguration(java.lang.String ecName)
ecName - The name of the executable component description of which to
retrieve the (unmerged) configuration of this configuration set.StorageActivityConfiguration getConfiguration(java.lang.String ecName, java.lang.String operationName)
ecName - The name of the executable component description which is
parent of the operation.operationName - The name of the operation of which to retrieve the
(unmerged) configuration of this configuration set.StorageConfiguration getTestConfiguration()
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.
Besides the normal configuration for the test mode in this configuration set the test configuration overrides and merges (secondly) with the corresponding parent test configurations. That is, the attribute contains only new entries and entries that are changed with respect to the normal configuration and the parent test configuration whereas the entries are identified by their name. However, the test configuration can not override the parent test configuration directly since the first overriding takes place with the normal configuration.
StorageConfiguration getTestConfiguration(java.lang.String ecName)
ecName - The name of the executable component description of which to
retrieve the (unmerged) test configuration of this configuration
set.StorageActivityConfiguration getTestConfiguration(java.lang.String ecName, java.lang.String operationName)
ecName - The name of the executable component description which is
parent of the operation.operationName - The name of the operation of which to retrieve the
(unmerged) test configuration of this configuration set.java.util.Map<java.lang.String,StorageParameterTemplate> getParameterTemplates()
This 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.
This attribute overrides and merges with the parameter templates of the corresponding parent entities. That is, the attribute contains new parameter templates, removed parameter templates and parameter templates that are changed with respect to the inherited ones whereas the parameter templates are identified by their name.
java.util.Map<java.lang.String,StorageParameterTemplate> getParameterTemplates(java.lang.String ecName)
ecName - The name of the executable component description of which to
retrieve the (unmerged) parameter templates of this configuration
set.java.util.Map<java.lang.String,StorageParameterTemplate> getParameterTemplates(java.lang.String ecName, java.lang.String operationName)
ecName - The name of the executable component description which is
parent of the operation.operationName - The name of the operation of which to retrieve the
(unmerged) parameter templates of this configuration set.java.lang.String getStaffAssignmentRule(java.lang.String ecName,
java.lang.String operationName)
null). This is for storing purpose only. Usually you should
retrieve the
merged staff
assignment rule.ecName - The name of the executable component description which is
parent of the operation.operationName - The name of the operation of which to retrieve the
staff assignment rule set by this configuration set.null in case this
configuration set does not explicitly defines one for the
designated operation.void setConfigurationDescription(StorageConfigurationDescription description)
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.
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.void setConfigurationDescription(StorageConfigurationDescription description, java.lang.String ecName)
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.
This attribute overrides and merges with the corresponding parent configuration descriptions. That is, the attribute contains only entries that are changed with respect to the inherited ones whereas the entries are identified by their name.
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.void setConfigurationDescription(StorageConfigurationDescription description, java.lang.String ecName, java.lang.String operationName)
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.
This attribute overrides and merges with the more general one and the corresponding parent configuration descriptions. That is, the attribute contains only entries that are changed with respect to the inherited ones whereas the entries are identified by their name.
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.void setConfiguration(StorageConfiguration 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.
This attribute overrides and merges with the corresponding parent configurations.
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. It may also contain more in case it provides values for
the configuration description of a parent entity. Use
null to remove the configuration from this
configuration set.void setConfiguration(StorageConfiguration configuration, java.lang.String ecName)
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.
This attribute overrides and merges with the general one and the corresponding parent configurations.
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. It may also contain more in case it provides values for
the configuration description of a parent entity. 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.void setConfiguration(StorageActivityConfiguration configuration, java.lang.String ecName, java.lang.String operationName)
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.
This attribute overrides and merges with the general ones (
getConfiguration(String) and getConfiguration()) and the
corresponding parent configurations.
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. It may also contain more in case it provides values for
the configuration description of a parent entity. 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.void setTestConfiguration(StorageConfiguration testConfiguration)
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.
This attribute overrides and merges with the normal configuration and afterwards with the corresponding parent test configurations.
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. It may
also contain more in case it provides values for the configuration
description of a parent entity. Use null to remove
the test configuration from this configuration set.void setTestConfiguration(StorageConfiguration testConfiguration, java.lang.String ecName)
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.
This attribute overrides and merges with the normal configuration and afterwards with the corresponding parent test configurations.
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. It may
also contain more in case it provides values for the configuration
description of a parent entity. 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.void setTestConfiguration(StorageActivityConfiguration testConfiguration, java.lang.String ecName, java.lang.String operationName)
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.
This attribute overrides and merges with the normal configuration and afterwards with the corresponding parent test configurations.
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. It may
also contain more in case it provides values for the configuration
description of a parent entity. 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.void setParameterTemplates(java.util.Map<java.lang.String,StorageParameterTemplate> parameterTemplates)
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.
This attribute overrides and merges with the parameter templates of the corresponding parent entities. That is, the attribute contains new parameter templates, removed parameter templates and parameter templates that are changed with respect to the inherited ones whereas the parameter templates are identified by their name.
parameterTemplates - A collection containing all parameter templates
that are defined for all activity template descriptions of this
configuration set.void setParameterTemplates(java.util.Map<java.lang.String,StorageParameterTemplate> parameterTemplates, java.lang.String ecName)
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.
This attribute overrides and merges with the general one and the parameter templates of the corresponding parent entities.
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.void setParameterTemplates(java.util.Map<java.lang.String,StorageParameterTemplate> parameterTemplates, java.lang.String ecName, java.lang.String operationName)
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.
This attribute overrides and merges with the general ones (
getParameterTemplates(String) and getParameterTemplates()
) and the parameter templates of the corresponding parent entities.
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.