Package de.aristaflow.adept2.model.activitymodel

Interface ActivityModelParameter

  • All Superinterfaces:
    AbstractActivityModelParameter, PluginDataContainer, UserAttributeContainer
    public interface ActivityModelParameter
extends AbstractActivityModelParameter
    An 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.
    Since they are part of the activity model, not all configuration entries from the 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.

    Author:
    Ulrich Kreher

    • Method Detail

      • getConfigurationDescription

        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. 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).
        Returns:
        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).

      • getConfiguration

        InheritedActivityConfiguration getConfiguration()
        Gets the configuration of this activity model parameter that corresponds to the 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).

        Returns:
        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).

      • setConfigurationDescription

        void setConfigurationDescription​(InheritedConfigurationDescription description)
        Sets the configuration description for this activity model parameter. 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 activity model parameter, 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 activity model parameter (which depends on the entity this parameter is retrieved from).

        Parameters:
        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).

      • setConfiguration

        void setConfiguration​(InheritedActivityConfiguration configuration)
        Sets the configuration for this activity model parameter. The provided configuration has to correspond to the configuration description of this activity model parameter and its parents (if existing), that is the values have to have appropriate configuration entries. Not all configuration entries need to have a value yet except the fixed ones. The values may also be retrieved from process parameters or the process configuration (determined 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).

        Parameters:
        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).