Package de.aristaflow.adept2.model.activitymodel

Interface StorageParameterTemplate

  • All Superinterfaces:
    AbstractParameterTemplate, PluginDataContainer, UserAttributeContainer
    public interface StorageParameterTemplate
extends AbstractParameterTemplate
    This interface provides the means to store ParameterTemplate which is supported by not inheriting any attributes from a parent parameter template (in contrast to the interface ParameterTemplate. 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.
    Author:
    Ulrich Kreher
    See Also:
    ParameterTemplate

    • Method Detail

      • getConfigurationDescription

        StorageConfigurationDescription getConfigurationDescription()
        Gets the configuration description for the parameter of this template without any inherited values. This defines the information needed in the parameter configuration.

        This attribute overrides and merges with the corresponding parent attribute. That is, the attribute contains only entries that are changed with respect to the ones of the parent attribute whereas the entries are identified by their name.

        Returns:
        The description for all configuration values of this parameter template, that is, the name of the configuration entries, their type and whether they are mandatory. These are only configuration entries that are modified with respect to the corresponding parent entity (if this exists).
        See Also:
        ParameterTemplate.getConfigurationDescription()

      • getConfiguration

        StorageConfiguration getConfiguration()
        Gets the default configuration for the parameter of this template that corresponds to the configuration description of this parameter template without any inherited values.

        This attribute overrides and merges with the corresponding parent attribute (if the parent exists). That is, the attribute contains only new entries and entries that are changed with respect to the ones of the parent attribute whereas the entries are identified by their name.

        Returns:
        The configuration values set for the parameter of this parameter template 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 (if this exists).

      • setConfigurationDescription

        void setConfigurationDescription​(StorageConfigurationDescription description)
        Sets the configuration description for the parameter of this template. The configuration description has to be set as a whole; to add or modify single entries, retrieve the complete description from this parameter template, add or modify the entry and provide the complete description again to this method. Use null to remove it from this activity parameter template and inherit the configuration description of the parent entity.

        This attribute overrides and merges with the corresponding parent attribute. That is, the attribute contains only entries that are changed with respect to the ones of the parent attribute whereas the entries are identified by their name.

        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 only configuration entries that are modified with respect to the corresponding parent parameter template (if existing). Use null to remove the configuration description.

      • setConfiguration

        void setConfiguration​(StorageConfiguration 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 parent (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 attribute overrides and merges with the corresponding parent attribute. That is, the attribute contains only new entries and entries that are changed with respect to the ones of the parent attribute whereas the entries are identified by their name.

        Parameters:
        configuration - The default configuration values set for the parameter of this template 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.