Package de.aristaflow.adept2.model.activitymodel

Interface ParameterTemplate

All Superinterfaces:
AbstractParameterTemplate, PluginDataContainer, UserAttributeContainer
public interface ParameterTemplate extends AbstractParameterTemplate
Generic operations allow to add parameters. To simplify this, parameter templates may be used that provide initial information on the supported parameters to be added. A generic operation does not need to be restricted to parameter templates, that is, it may also allow newly created parameters but it may also provide templates for all allowed parameters.
A parameter template itself does not need to provide all attributes for a new parameter, that is, unset attributes have to be defined when instantiating it (creating a new parameter based on the corresponding template). Attributes provided by a template may not be changed when creating the corresponding parameter!

A parameter template may be overridden and therefore provides methods to check the inheritance for all of its attributes. However the attributes will only be able to be overridden if the parent parameter template has a do not care value for the specific attribute. If you need to change an existing attribute value, you will have to create a new parameter template with the very same attributes except the one(s) to change.

Author:
Ulrich Kreher

  • Method Details

    • getConfigurationDescription

      InheritedConfigurationDescription 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

      InheritedConfiguration 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).

    • setConfigurationDescription

      void setConfigurationDescription(InheritedConfigurationDescription description)
      Sets the configuration description for the parameter of this template. This defines the information needed in the parameter configuration. This may change the configuration description of the corresponding parent parameter by overriding its values.
      The configuration description has to be set as a whole; to add or modify single entries, retrieve the complete inherited description from this parameter template, add or modify the entry and provide the complete inherited description again to this method.

      This configuration description is merged with the configuration description of the parent parameter template (which depends on the entity this parameter is retrieved from). It may not override the configuration description of a parent parameter template. If you need to overwrite some parts of the configuration description, you will have to create a new parameter template (with another name) that copies all attributes of the parent parameter template.

      Parameters:
      description - The description for all configuration values of the parameter of this parameter template, that is, the name of the configuration entries, their type and whether they are mandatory. These are all configuration entries provided by this parameter template as well as the corresponding parent entities (if they exist).

    • setConfiguration

      void setConfiguration(InheritedConfiguration configuration)
      Sets the default configuration for the parameter of this template. The provided configuration has to correspond to the configuration description of this parameter template and its parents (if existing), that is all values have to have appropriate configuration entries. Not all configuration entries need to have a value yet. A description entry without a corresponding configuration value allows/requires the user to set it.
      The configuration needs to be provided as a whole, that is you can not remove or add values directly but by manipulating and providing the whole data structure.

      This configuration is merged with the configuration of the parent activity model parameter (which depends on the entity this parameter is retrieved from). It may not override the configuration of a parent parameter template. If you need to overwrite some parts of the configuration, you will have to create a new parameter template (with another name) that copies all attributes of the parent parameter template.

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