public interface ATParameterTemplate extends UserAttributeContainer, PluginDataContainer
ATParameterTemplate represents a
ParameterTemplate but only provides the information needed when
assigning (dragging) an activity (template definition) to a process node.
That is, unlike ParameterTemplates these parameter templates are
not subject of inheritance any more and provide all attributes as combination
of the attributes of the corresponding activity model branch. Additionally,
they do not allow to change any attribute. This is just like the behaviour of
ActivityTemplates.ActivityTemplate| Modifier and Type | Method and Description |
|---|---|
ActivityConstants.AccessType |
getAccessType()
Gets the access type for the parameter of this template.
|
Configuration |
getConfiguration()
Gets the default configuration for the parameter of this template that
corresponds to the
configuration
description of this parameter template. |
ConfigurationDescription |
getConfigurationDescription()
Gets the configuration description for the parameter of this template.
|
ProcessConstants.AdeptDataType |
getDataType()
Gets the data type for the parameter of this template.
|
java.lang.String |
getDefaultValue()
Gets the string representation for the default value for the parameter of
this template.
|
java.lang.String |
getDescription()
Gets the description for the parameter of this template.
|
java.util.UUID |
getIdentifierID()
Gets the ID of the identifier for the parameter of this template.
|
java.lang.String |
getName()
Gets the name for the parameter of this template.
|
java.lang.String |
getTemplateDescription()
Gets a description for the process modeler and the administrator of the
activity model.
|
java.lang.String |
getTemplateName()
Gets the unique (with respect to the corresponding entity) name of this
parameter template.
|
java.lang.String |
getUDTName()
Gets the name for the user-defined data type for the parameter of this
template.
|
java.lang.Boolean |
isFailure()
Gets whether the parameter of this template is a failure parameter and
therefore all other output parameters are treated as optional if explicitly
mapped to a data element.
|
java.lang.Boolean |
isOptional()
Gets whether the parameter of this template is optional and therefore may
have a value of null at runtime.
|
java.lang.Boolean |
isVirtual()
Gets whether the parameter of this template is virtual and therefore is not
provided to the implementation of the corresponding operation.
|
getUserAttributes, getUserAttributeValue, removeUserAttributeValue, setUserAttributeValuegetPluginData, getPluginDatas, getSupportedPluginsjava.lang.String getTemplateName()
java.lang.String getTemplateDescription()
ActivityConstants.AccessType getAccessType()
The access type may be null in which case it is interpreted as do not care and the user needs to assign one when creating the corresponding parameter.
java.lang.String getName()
The name of the parameter may be localised which will be applied to the created parameter accordingly. The name may be null in which case it is interpreted as do not care and the user needs to assign one when creating the corresponding parameter.
java.lang.String getDescription()
The description of the parameter may be localised which will be applied to the created parameter accordingly. The description may be null in which case it is interpreted as do not care and the user may assign one when creating the corresponding parameter.
ProcessConstants.AdeptDataType getDataType()
The data type may be null in which case it is interpreted as do not care and the user may needs to assign one when creating the corresponding parameter.
java.lang.String getUDTName()
USERDEFINED for the created parameter. This may either be due
to the data type set in the template or by the user.
The name of the user-defined data type may be null in which case it is interpreted as do not care and the user may assign one when creating the corresponding parameter.
java.util.UUID getIdentifierID()
The ID may be null in which case it is interpreted as do not care and the user needs to assign one when creating the corresponding parameter.
ConfigurationDescription getConfigurationDescription()
Configuration getConfiguration()
configuration
description of this parameter template. These configuration values are
merged with the configuration of the parent parameter template (which
depends on the entity this parameter template is retrieved from).java.lang.Boolean isOptional()
This flag may be null in which case it is interpreted as do not care and the user needs to set it when creating the corresponding parameter.
java.lang.Boolean isVirtual()
This flag may be null in which case it is interpreted as do not care and the user needs to set it when creating the corresponding parameter.
java.lang.Boolean isFailure()
This flag may be null in which case it is interpreted as do not care and the user needs to set it when creating the corresponding parameter.
java.lang.String getDefaultValue()
The value string may be null in which case it is interpreted as do not care and the user may assign one when creating the corresponding parameter.