public interface ActivityModelParameter extends AbstractActivityModelParameter
ActivityModelParameter resembles a Parameter by
additional information needed in the activity model. Additionally, they are
subject of inheritance, that is, one ActivityModelParameter may
override the attributes of the corresponding
ActivityModelParameter of a parent entity (the
Operation in case of an ActivityTemplateDefinition).
Parameters are identified by their name, overriding also
takes place by the parameter name. configuration description need to
have values yet. They may be provided when modelling a process.
Note the restrictions that apply when setting some of the attributes, for instance failure, default value and virtual.
Since an ActivityModelParameter is subject of inheritance and
only used in the activity model, it is separated from the
Parameter-class-hierarchy.
| Modifier and Type | Method and Description |
|---|---|
InheritedActivityConfiguration |
getConfiguration()
Gets the configuration of this activity model parameter that corresponds to
the
configuration description of
this activity model parameter. |
InheritedConfigurationDescription |
getConfigurationDescription()
Gets the configuration description for this activity model parameter which
is needed to provide a valid and complete
configuration when modelling a process. |
void |
setConfiguration(InheritedActivityConfiguration configuration)
Sets the configuration for this activity model parameter.
|
void |
setConfigurationDescription(InheritedConfigurationDescription description)
Sets the configuration description for this activity model parameter.
|
getDataType, getDefaultValue, getDescription, getDeveloperDescription, getIdentifierID, getName, getUDTName, isDataTypeInherited, isDefaultValueInherited, isDescriptionInherited, isDeveloperDescriptionInherited, isFailure, isFailureInherited, isIdentifierIDInherited, isOptional, isOptionalInherited, isVirtual, isVirtualInherited, removeOwnDataType, removeOwnDefaultValue, removeOwnDescription, removeOwnDeveloperDescription, removeOwnFailure, removeOwnIdentifierID, removeOwnOptional, removeOwnVirtual, setDataType, setDefaultValue, setDescription, setDeveloperDescription, setFailure, setIdentifierID, setName, setOptional, setVirtualgetUserAttributes, getUserAttributeValue, removeUserAttributeValue, setUserAttributeValuegetPluginData, getPluginDatas, getSupportedPluginsInheritedConfigurationDescription getConfigurationDescription()
configuration when modelling a process. This configuration description is
merged with the configuration description of the parent activity model
parameter (which depends on the entity this parameter is retrieved from).InheritedActivityConfiguration getConfiguration()
configuration description of
this activity model parameter. These configuration values may be overridden
(unless
fixed) and not all configuration values need to be provided yet.
Configuration values may also be provided via an input parameter (which has
to exist for this operation then) or from a process configuration (which is
needed when modelling).
This configuration is merged with the configuration of the parent activity model parameter (which depends on the entity this parameter is retrieved from).
void setConfigurationDescription(InheritedConfigurationDescription description)
This configuration description is merged with the configuration description of the parent activity model parameter (which depends on the entity this parameter is retrieved from).
description - The description for all configuration values of this
activity model parameter, that is, the name of the configuration
entries, their type and whether they are mandatory. These are all
configuration entries provided by this parameter as well as the
corresponding parent entities (if they exist).void setConfiguration(InheritedActivityConfiguration configuration)
This configuration is merged with the configuration of the parent activity model parameter (which depends on the entity this parameter is retrieved from).
configuration - The configuration values set for this activity model
parameter based on the configuration description. These are all
configuration values provided by this parameter as well as the
corresponding parent entities (if they exist).