Package de.aristaflow.adept2.model.activitymodel

Interface StorageConfigurationSet

  • All Superinterfaces:
    AbstractConfigurationSet, PluginDataContainer, UserAttributeContainer
    public interface StorageConfigurationSet
extends AbstractConfigurationSet
    This interface provides the means to store an ActivityModelParameter which is supported by not inheriting any attributes from a parent parameter (in contrast to the interface ActivityModelParameter. 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:
    ConfigurationSet

    • Method Detail

      • getConfigurationDescription

        StorageConfigurationDescription getConfigurationDescription()
        Gets the configuration description for this whole configuration set, that is a description of all configuration values that are needed or supported at runtime for all activity templates of this configuration set. This is based on the configuration description of all operations of this configuration sets as well as their executable component descriptions. It does not contain any conflicting entries, that are entries of the same name that are of different type defined in different configuration descriptions. These configuration entries may be subject of overriding, that is, their description, their restrictions and their optional state may be changed.
        Therefore this configuration description may contain copies and override some or all of the entries of its operations and executable component descriptions. However, when merging an activity model branch, such a configuration description will override and merge with the appropriate configuration description from the operation and the executable component description from this activity model branch.
        Returns:
        The description for the configuration values of this configuration set, that is, the name of the configuration entries, their type and whether they are mandatory. This applies to all activity template definitions of this configuration set.

      • getConfigurationDescription

        StorageConfigurationDescription getConfigurationDescription​(String ecName)
        Gets the (unmerged) configuration description for the activity template definitions of this configuration set that are based on the designated executable component description. This is for storing purpose only. Usually you should retrieve the merged configuration description.
        Parameters:
        ecName - The name of the executable component description of which to retrieve the (unmerged) configuration description of this configuration set.
        Returns:
        The (unmerged) description for the configuration values of this configuration set, that is, the name of the configuration entries, their type and whether they are mandatory. This applies only to activity template definitions based on the designated executable component description. If this configuration set does not define a configuration description for the designated executable component description, an empty configuration description will be returned.

      • getConfigurationDescription

        StorageConfigurationDescription getConfigurationDescription​(String ecName,
                                                            String operationName)
        Gets the (unmerged) configuration description for the activity template definitions of this configuration set that are based on the designated operation. This is for storing purpose only. Usually you should retrieve the merged configuration description.
        Parameters:
        ecName - The name of the executable component description which is parent of the operation.
        operationName - The name of the operation of which to retrieve the (unmerged) configuration description of this configuration set.
        Returns:
        The (unmerged) description for the configuration values of this configuration set, that is, the name of the configuration entries, their type and whether they are mandatory. This applies only to activity template definitions based on the designated executable component description. If this configuration set does not define a configuration description for the designated operation, an empty configuration description will be returned.

      • getConfiguration

        StorageConfiguration getConfiguration()
        Gets the configuration for this whole configuration set that corresponds to the configuration description of this configuration set. This configuration may be overridden in the corresponding activity template definitions (unless fixed) and not all configuration values need to be provided yet.

        Configurations values of configuration sets may not be provided via input parameters or from a process configuration! However, the corresponding activity template definitions may override this and use an input parameter or the process configuration.

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

        Returns:
        The configuration values set for this configuration set based on the configuration description. This does not necessarily contain all values since they can still be set when modelling. This applies to all activity template definitions of this configuration set.

      • getConfiguration

        StorageConfiguration getConfiguration​(String ecName)
        Gets the (unmerged) configuration for the activity template definitions of this configuration set that are based on the designated executable component description. This is for storing purpose only. Usually you should retrieve the merged configuration.
        Parameters:
        ecName - The name of the executable component description of which to retrieve the (unmerged) configuration of this configuration set.
        Returns:
        The (unmerged) configuration values for this configuration set based on the configuration description. This applies only to activity template definitions based on the designated executable component description. If this configuration set does not define configuration values for the designated executable component description, an empty configuration will be returned.

      • getConfiguration

        StorageActivityConfiguration getConfiguration​(String ecName,
                                              String operationName)
        Gets the (unmerged) configuration for the activity template definitions of this configuration set that are based on the designated operation. This is for storing purpose only. Usually you should retrieve the merged configuration.
        Parameters:
        ecName - The name of the executable component description which is parent of the operation.
        operationName - The name of the operation of which to retrieve the (unmerged) configuration of this configuration set.
        Returns:
        The (unmerged) configuration values for this configuration set based on the configuration description. This applies only to activity template definitions based on the designated operation. If this configuration set does not define configuration values for the designated operation, an empty configuration will be returned.

      • getTestConfiguration

        StorageConfiguration getTestConfiguration()
        Gets the test configuration for this whole configuration set that corresponds to the configuration description of this configuration set. These configuration values only apply when executing in test mode, that is the corresponding operation is provided this configuration instead of the normal configuration. This test configuration will be merged with the normal configuration, therefore only changed values have to be provided. Note that the test configuration allows to override fixed values of the normal configuration. Clearly in case of an empty test configuration the normal configuration will be used in test mode.

        Configurations values of configuration sets may not be provided via input parameters or from a process configuration! However, the corresponding activity template definitions may override this and use an input parameter or the process configuration.

        Besides the normal configuration for the test mode in this configuration set the test configuration overrides and merges (secondly) with the corresponding parent test configurations. That is, the attribute contains only new entries and entries that are changed with respect to the normal configuration and the parent test configuration whereas the entries are identified by their name. However, the test configuration can not override the parent test configuration directly since the first overriding takes place with the normal configuration.

        Returns:
        The configuration values set for the test mode of the activity template definitions of this configuration set based on the configuration description. If this is an empty configuration, the normal configuration will be used in test mode. This applies to all activity template definitions of this configuration set.

      • getTestConfiguration

        StorageConfiguration getTestConfiguration​(String ecName)
        Gets the (unmerged) test configuration for the activity template definitions of this configuration set that are based on the designated executable component description. This is for storing purpose only. Usually you should retrieve the merged test configuration.
        Parameters:
        ecName - The name of the executable component description of which to retrieve the (unmerged) test configuration of this configuration set.
        Returns:
        The (unmerged) test configuration values for this configuration set based on the configuration description. This applies only to activity template definitions based on the designated executable component description. If this configuration set does not define test configuration values for the designated executable component description, an empty configuration will be returned.

      • getTestConfiguration

        StorageActivityConfiguration getTestConfiguration​(String ecName,
                                                  String operationName)
        Gets the (unmerged) test configuration for the activity template definitions of this configuration set that are based on the designated operation. This is for storing purpose only. Usually you should retrieve the merged test configuration.
        Parameters:
        ecName - The name of the executable component description which is parent of the operation.
        operationName - The name of the operation of which to retrieve the (unmerged) test configuration of this configuration set.
        Returns:
        The (unmerged) test configuration values for this configuration set based on the configuration description. This applies only to activity template definitions based on the designated operation. If this configuration set does not define test configuration values for the designated operation, an empty configuration will be returned.

      • getParameterTemplates

        Map<String,​StorageParameterTemplate> getParameterTemplates()
        Gets parameter templates that are defined for all activity template definitions of this configuration set. This allows to simplify the creation of parameters for activity template definitions and activity templates for operations with a non-fixed interfaces (generic interfaces).

        This templates need not be used at all when creating parameters. If a component needs to ensure that only these templates are used, an appropriate check needs to be provided that verifies the created parameters.

        This attribute overrides and merges with the parameter templates of the corresponding parent entities. That is, the attribute contains new parameter templates, removed parameter templates and parameter templates that are changed with respect to the inherited ones whereas the parameter templates are identified by their name.

        Returns:
        Templates for parameters (mapped from parameter template name to the corresponding parameter template) that may be added to all the activity template definitions of this configuration set.

      • getParameterTemplates

        Map<String,​StorageParameterTemplate> getParameterTemplates​(String ecName)
        Gets the (unmerged) parameter templates that are defined for the activity template definitions of this configuration set that are based on the designated executable component description. This is for storing purpose only. Usually you should retrieve the merged parameter templates.
        Parameters:
        ecName - The name of the executable component description of which to retrieve the (unmerged) parameter templates of this configuration set.
        Returns:
        (Unmerged) templates for parameters (mapped from parameter template name to the corresponding parameter template) that may be added to the activity template definitions of this configuration set based on the designated executable component description. If this configuration set does not define parameter templates for the designated executable component description, an empty collection will be returned.

      • getParameterTemplates

        Map<String,​StorageParameterTemplate> getParameterTemplates​(String ecName,
                                                                 String operationName)
        Gets the (unmerged) parameter templates that are defined for the activity template definitions of this configuration set that are based on the designated operation. This is for storing purpose only. Usually you should retrieve the merged parameter templates.
        Parameters:
        ecName - The name of the executable component description which is parent of the operation.
        operationName - The name of the operation of which to retrieve the (unmerged) parameter templates of this configuration set.
        Returns:
        (Unmerged) templates for parameters (mapped from parameter template name to the corresponding parameter template) that may be added to the activity template definitions of this configuration set based on the designated operation. If this configuration set does not define parameter templates for the designated operation, an empty collection will be returned.

      • getStaffAssignmentRule

        String getStaffAssignmentRule​(String ecName,
                              String operationName)
        Gets the (non-inherited) staff assignment rule that is proposed by the administrator of the activity model for the activity template definitions of this configuration set that are based on the designated operation. The staff assignment rule is not inherited (and therefore may be null). This is for storing purpose only. Usually you should retrieve the merged staff assignment rule.
        Parameters:
        ecName - The name of the executable component description which is parent of the operation.
        operationName - The name of the operation of which to retrieve the staff assignment rule set by this configuration set.
        Returns:
        The staff assignment rule that is proposed by the administrator of the activity model for the activity template definitions based on the designated operation or null in case this configuration set does not explicitly defines one for the designated operation.

      • setConfigurationDescription

        void setConfigurationDescription​(StorageConfigurationDescription description)
        Sets the configuration description for this whole configuration set, that is a description of all configuration values that are needed or supported at runtime for all activity templates of this configuration set. This also provides whether a configuration value is mandatory and its type.

        The designated configuration description has to be based on the configuration descriptions of the operations and executable component descriptions of this configuration set. It must not contain any conflicting entries, that are entries of the same name that are of different type defined in different configuration descriptions. However, these configuration entries may be subject of overriding, that is, their description, their restrictions and their optional state may be changed.

        The configuration description has to be set as a whole; to add or modify single entries, retrieve the complete description, add or modify the entry by respecting the constraints and provide the complete description again to this method. Use null to remove it.

        Parameters:
        description - The description for the configuration values of this configuration set, that is, the name of the configuration entries, their type and whether they are mandatory. Use null to remove the configuration description.

      • setConfigurationDescription

        void setConfigurationDescription​(StorageConfigurationDescription description,
                                 String ecName)
        Sets the configuration description for the activity template definitions of this configuration set that are based on the designated executable. That is a description of all configuration values that are needed or supported at runtime. This also provides whether a configuration value is mandatory and its type. An operation of the designated executable component description has to be in this configuration set!

        The configuration description has to be set as a whole; to add or modify single entries, retrieve the complete description, add or modify the entry and provide the complete description again to this method. Use null to remove it.

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

        Parameters:
        ecName - The name of the executable component description of which to set the overriding configuration description of this configuration set.
        description - The description for the configuration values of this configuration set, that is, the name of the configuration entries, their type and whether they are mandatory. This applies only to activity template definitions based on the designated executable component description. Use null to remove the configuration description.

      • setConfigurationDescription

        void setConfigurationDescription​(StorageConfigurationDescription description,
                                 String ecName,
                                 String operationName)
        Sets the configuration description for the activity template definitions of this configuration set that are based on the designated operation. That is a description of all configuration values that are needed or supported at runtime. This also provides whether a configuration value is mandatory and its type. The designated operation has to be in this configuration set!

        The configuration description has to be set as a whole; to add or modify single entries, retrieve the complete description, add or modify the entry and provide the complete description again to this method. Use null to remove it.

        This attribute overrides and merges with the more general one and the corresponding parent configuration descriptions. That is, the attribute contains only entries that are changed with respect to the inherited ones whereas the entries are identified by their name.

        Parameters:
        ecName - The name of the executable component description which is parent of the operation.
        operationName - The name of the operation of which to set the overriding configuration description of this configuration set.
        description - The description for the configuration values of this configuration set, that is, the name of the configuration entries, their type and whether they are mandatory. This applies only to activity template definitions based on the designated operation. Use null to remove the configuration description.

      • setConfiguration

        void setConfiguration​(StorageConfiguration configuration)
        Sets the configuration for this whole configuration set. The provided configuration has to correspond to the configuration description of this configuration set. That is the values have to have appropriate configuration entries. Not all configuration entries need to have a value yet except the fixed ones. However, configurations values of configuration sets may not be provided via input parameters or from a process configuration!

        The configuration has to be set as a whole; to add or modify single values, retrieve the complete configuration, add or modify the value and provide the complete configuration again to this method. Use null to remove the configuration from this configuration set.

        This attribute overrides and merges with the corresponding parent configurations.

        Parameters:
        configuration - The configuration values set for this configuration set 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 from this configuration set.

      • setConfiguration

        void setConfiguration​(StorageConfiguration configuration,
                      String ecName)
        Sets the configuration for the activity template definitions of this configuration set that are based on the designated executable component description. The provided configuration has to correspond to the configuration description of this configuration set for the designated executable component description and/or to the configuration description of the designated executable component description. That is the values have to have appropriate configuration entries. Not all configuration entries need to have a value yet except the fixed ones. However, configurations values of configuration sets may not be provided via input parameters or from a process configuration!

        The configuration has to be set as a whole; to add or modify single values, retrieve the complete configuration, add or modify the value and provide the complete configuration again to this method. Use null to remove the configuration of the designated executable component description from this configuration set.

        This attribute overrides and merges with the general one and the corresponding parent configurations.

        Parameters:
        ecName - The name of the executable component description of which to set the overriding configuration values of this configuration set. An operation of this executable component description has to be in this configuration set.
        configuration - The configuration values set for this configuration set 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. This applies only to activity template definitions based on the designated executable component description. Use null to remove the configuration of the designated executable component description from this configuration set.

      • setConfiguration

        void setConfiguration​(StorageActivityConfiguration configuration,
                      String ecName,
                      String operationName)
        Sets the configuration for the activity template definitions of this configuration set that are based on the designated operation. The provided configuration has to correspond to the configuration description of this configuration set for the designated operation and/or to the configuration description of the designated operation as well as the configuration description of the corresponding executable component description. That is the values have to have appropriate configuration entries. Not all configuration entries need to have a value yet except the fixed ones. However, configurations values of configuration sets may not be provided via input parameters or from a process configuration!

        The configuration has to be set as a whole; to add or modify single values, retrieve the complete configuration, add or modify the value and provide the complete configuration again to this method. Use null to remove the configuration of the designated operation from this configuration set.

        This attribute overrides and merges with the general ones ( getConfiguration(String) and getConfiguration()) and the corresponding parent configurations.

        Parameters:
        ecName - The name of the executable component description which is parent of the operation.
        operationName - The name of the operation of which to set the overriding configuration values of this configuration set. This operation has to be in this configuration set.
        configuration - The configuration values set for this configuration set 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. This applies only to activity template definitions based on the designated operation. Use null to remove the configuration of the designated operation from this configuration set.

      • setTestConfiguration

        void setTestConfiguration​(StorageConfiguration testConfiguration)
        Sets the test configuration for this whole configuration set. The provided configuration has to correspond to the configuration description of this configuration set. That is the values have to have appropriate configuration entries.
        These configuration values only apply when executing in test mode, that is the corresponding operation is provided this configuration instead of the normal configuration. This test configuration will be merged with the normal configuration, therefore only changed values have to be provided. However, configurations values of configuration sets may not be provided via input parameters or from a process configuration!
        Note that the test configuration allows to override fixed values of the normal configuration. Clearly in case of an empty test configuration the normal configuration will be used in test mode.

        The configuration has to be set as a whole; to add or modify single values, retrieve the complete configuration, add or modify the value and provide the complete configuration again to this method. Use null to remove it from this configuration set.

        This attribute overrides and merges with the normal configuration and afterwards with the corresponding parent test configurations.

        Parameters:
        testConfiguration - The test configuration values set for this configuration set based on the configuration description. This does not necessarily contain all values since they can still be set when modelling or taken form the normal configuration. It may also contain more in case it provides values for the configuration description of a parent entity. Use null to remove the test configuration from this configuration set.

      • setTestConfiguration

        void setTestConfiguration​(StorageConfiguration testConfiguration,
                          String ecName)
        Sets the test configuration for the activity template definitions of this configuration set. The provided configuration has to correspond to the configuration description of this configuration set for the designated executable component description. That is the values have to have appropriate configuration entries.
        These configuration values only apply when executing in test mode, that is the corresponding operation is provided this configuration instead of the normal configuration. This test configuration is merged with the normal configuration. However, configurations values of configuration sets may not be provided via input parameters or from a process configuration!
        Note that the test configuration allows to override fixed values of the normal configuration. Clearly in case of an empty test configuration the normal configuration will be used in test mode.

        The configuration has to be set as a whole; to add or modify single values, retrieve the complete configuration, add or modify the value and provide the complete configuration again to this method. Use null to remove the test configuration of the designated executable component description from this configuration set.

        This attribute overrides and merges with the normal configuration and afterwards with the corresponding parent test configurations.

        Parameters:
        ecName - The name of the executable component description of which to set the test configuration values of this configuration set. An operation of this executable component description has to be in this configuration set.
        testConfiguration - The test configuration values set for this configuration set based on the configuration description. This does not necessarily contain all values since they can still be set when modelling or taken form the normal configuration. It may also contain more in case it provides values for the configuration description of a parent entity. This applies only to activity template definitions based on the designated executable component description. Use null to remove the test configuration of the designated executable component description from this configuration set.

      • setTestConfiguration

        void setTestConfiguration​(StorageActivityConfiguration testConfiguration,
                          String ecName,
                          String operationName)
        Sets the test configuration for the activity template definitions of this configuration set that are based on the designated operation. The provided configuration has to correspond to the configuration description of this configuration set for the designated operation and/or to the configuration description of the designated operation as well as the configuration description of the corresponding executable component description. That is the values have to have appropriate configuration entries.
        These configuration values only apply when executing in test mode, that is the corresponding operation is provided this configuration instead of the normal configuration. This test configuration is merged with the normal configuration. However, configurations values of configuration sets may not be provided via input parameters or from a process configuration!
        Note that the test configuration allows to override fixed values of the normal configuration. Clearly in case of an empty test configuration the normal configuration will be used in test mode.

        The configuration has to be set as a whole; to add or modify single values, retrieve the complete configuration, add or modify the value and provide the complete configuration again to this method. Use null to remove the test configuration of the designated operation from this configuration set.

        This attribute overrides and merges with the normal configuration and afterwards with the corresponding parent test configurations.

        Parameters:
        ecName - The name of the executable component description which is parent of the operation.
        operationName - The name of the operation of which to set the test configuration values of this configuration set. This operation has to be in this configuration set.
        testConfiguration - The test configuration values set for this configuration set based on the configuration description. This does not necessarily contain all values since they can still be set when modelling or taken form the normal configuration. It may also contain more in case it provides values for the configuration description of a parent entity. This applies only to activity template definitions based on the designated operation. Use null to remove the test configuration of the designated operation from this configuration set.

      • setParameterTemplates

        void setParameterTemplates​(Map<String,​StorageParameterTemplate> parameterTemplates)
        Sets parameter templates that are defined for all activity template definitions of this configuration set. This allows to simplify the creation of parameters for activity template definitions and activity templates for operations with a non-fixed interfaces (generic interfaces).

        When setting the parameter templates the whole collection has to be set, even in case only one parameter template has been modified. Use null for removing all parameter templates for this configuration set.

        This attribute overrides and merges with the parameter templates of the corresponding parent entities. That is, the attribute contains new parameter templates, removed parameter templates and parameter templates that are changed with respect to the inherited ones whereas the parameter templates are identified by their name.

        Parameters:
        parameterTemplates - A collection containing all parameter templates that are defined for all activity template descriptions of this configuration set.

      • setParameterTemplates

        void setParameterTemplates​(Map<String,​StorageParameterTemplate> parameterTemplates,
                           String ecName)
        Sets parameter templates that are defined for the activity template definitions of this configuration set that are based on the designated executable component description. This allows to simplify the creation of parameters for activity template definitions and activity templates for operations with a non-fixed interfaces (generic interfaces).

        When setting the parameter templates the whole collection has to be set, even in case only one parameter template has been modified. Use null for removing all parameter templates for the designated executable component description of this configuration set, that is, the parameter templates will be inherited from the executable component description again.

        This attribute overrides and merges with the general one and the parameter templates of the corresponding parent entities.

        Parameters:
        parameterTemplates - A collection containing all parameter templates that are defined for the activity template descriptions of this configuration set that are based on the designated executable component description.
        ecName - The name of the executable component description of which to set the parameter templates of this configuration set.

      • setParameterTemplates

        void setParameterTemplates​(Map<String,​StorageParameterTemplate> parameterTemplates,
                           String ecName,
                           String operationName)
        Sets parameter templates that are defined for the activity template definitions of this configuration set that are based on the designated operation. This allows to simplify the creation of parameters for activity template definitions and activity templates for operations with a non-fixed interfaces (generic interfaces).

        When setting the parameter templates the whole collection has to be set, even in case only one parameter template has been modified. Use null for removing all parameter templates for the designated operation of this configuration set, that is, the parameter templates will be inherited from the operation again.

        This attribute overrides and merges with the general ones ( getParameterTemplates(String) and getParameterTemplates() ) and the parameter templates of the corresponding parent entities.

        Parameters:
        parameterTemplates - A collection containing all parameter templates that are defined for the activity template descriptions of this configuration set that are based on the designated operation.
        ecName - The name of the executable component description which is parent of the operation.
        operationName - The name of the operation of which to set the parameter templates of this configuration set.