de.aristaflow.adept2.model.activitymodel

Interface ATParameterTemplate

All Superinterfaces:

PluginDataContainer, UserAttributeContainer

public interface ATParameterTemplate
extends UserAttributeContainer, PluginDataContainer

An 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.

Author:

Ulrich Kreher

See Also:

ActivityTemplate

Method Summary

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.

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

getUserAttributes, getUserAttributeValue, removeUserAttributeValue, setUserAttributeValue

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

getPluginData, getPluginDatas, getSupportedPlugins

Method Detail

getTemplateName

java.lang.String getTemplateName()

Gets the unique (with respect to the corresponding entity) name of this parameter template. This is used to identify the template and provide a name for the user when creating new parameters.

Returns:

The unique (with respect to the corresponding entity) name of this parameter template.

getTemplateDescription

java.lang.String getTemplateDescription()

Gets a description for the process modeler and the administrator of the activity model. This description is not propagated to the corresponding parameter.

Returns:

A description for the process modeler and the administrator of the activity model. This description is not propagated to the corresponding parameter.

getAccessType

ActivityConstants.AccessType getAccessType()

Gets the access type for the parameter of this template.

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.

Returns:

The access type for a parameter of this template, that is a parameter created based on this template will have this access type.

getName

java.lang.String getName()

Gets the name for the parameter of this template. Note that this name is to be unique for the designated entity and the access type. There may be templates for several parameters having the same name but when adding parameters only one of this will be able to be used.

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.

Returns:

The name for a parameter of this template, that is a parameter created based on this template will have this name.

getDescription

java.lang.String getDescription()

Gets the description for the parameter of this template. This is some arbitrary text describing the usage of the parameter (not the usage of the parameter template).

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.

Returns:

The description for a parameter of this template, that is a parameter created based on this template will have this description.

getDataType

ProcessConstants.AdeptDataType getDataType()

Gets the data type for the parameter of this template.

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.

Returns:

The data type for a parameter of this template, that is a parameter created based on this template will have this data type.

getUDTName

java.lang.String getUDTName()

Gets the name for the user-defined data type for the parameter of this template. This name will only used in case the data type is 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.

Returns:

The name for the user-defined data type for a parameter of this template, that is a parameter created based on this template will have this user-defined data type name.

getIdentifierID

java.util.UUID getIdentifierID()

Gets the ID of the identifier for the parameter of this template.

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.

Returns:

The ID of the identifier for a parameter of this template, that is a parameter created based on this template will have this identifier.

getConfigurationDescription

ConfigurationDescription getConfigurationDescription()

Gets the configuration description for the parameter of this template. This defines the information needed in the parameter configuration. This configuration description is merged with the configuration description of the parent parameter template (which depends on the entity this parameter template is retrieved from).

Returns:

The description for all configuration values of the parameter of this parameter template. These are all configuration entries provided by this parameter template as well as the corresponding parent entities (if they exist).

getConfiguration

Configuration getConfiguration()

Gets the default configuration for the parameter of this template that corresponds to the 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).

Returns:

The configuration values set for the parameter of this parameter template. based on the configuration description. These are all configuration values provided by this parameter template as well as the corresponding parent entities (if they exist).

isOptional

java.lang.Boolean isOptional()

Gets whether the parameter of this template is optional and therefore may have a value of null at runtime.

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.

Returns:

Whether a parameter of this template is optional and therefore may have a value of null at runtime.

isVirtual

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.

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.

Returns:

Whether a parameter of this template is virtual and therefore is not provided to the implementation of the corresponding operation.

isFailure

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. However, the parameters itself remain mandatory (not optional), only the data edge will be optional.

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.

Returns:

Whether a parameter of this template is a failure parameter and therefore its mapping to a data element sets all other parameters to optional.

getDefaultValue

java.lang.String getDefaultValue()

Gets the string representation for the default value for the parameter of this template. The string representation conforms to the string representation in configurations, that is, the same transformation is applied for non-string types, for instance user-defined data types. This transformation is the only way to allow for complex data types in simple configuration files which are usually based on simple strings.

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.

Returns:

The string representation for the default value of the parameter of this template. The representation conforms to the string representation used in configurations for complex data types.