Package de.aristaflow.adept2.model.activitymodel

Interface StorageActivityTemplateDefinition

    • Method Detail

      • getExecutableComponentName

        String getExecutableComponentName()
        Gets the system-wide unique name of the ExecutableComponentDescription this activity template definition is based upon.
        Returns:
        The system-wide unique name of the ExecutableComponentDescription this activity template definition is based upon which also identifies the configurations that apply at runtime

      • getOperationName

        String getOperationName()
        Gets the name of the operation (unique with respect to the ExecutableComponentDescription) this activity template definition belongs to. This name is used in configurations that apply at runtime for operation-specific configurations. Therefore one may have configuration values for executable components as well as operations.
        Returns:
        The name of the operation (unique with respect to the ExecutableComponentDescription) this activity template definition is based upon.

      • getConfigurationSetName

        String getConfigurationSetName()
        Gets the configuration set of this activity template definition or null in case this activity template definition does not have a configuration set.
        Returns:
        The configuration set of this activity template definition or null.

      • getClassPath

        List<String> getClassPath()
        Gets the part of the classpath that is added by this activity template definition to the one of the parent attribute. In case this activity template definition does not supplement the classpath this will be an empty list.
        Returns:
        The part of the classpath that is contributed by this activity template definition. This is appended to the classpath of the parent entity and thus forms the complete classpath.

      • getConfigurationDescription

        StorageConfigurationDescription getConfigurationDescription()
        Gets the configuration description for this activity template. This may override the configuration description of the corresponding executable component description, operation and configuration set.

        This attribute overrides and merges with the corresponding parent attribute (configuration descriptions from the configuration set and/or Operation.getConfigurationDescription()).

        Returns:
        The description for all configuration values of this activity template definition, that is, the name of the configuration entries, their type and whether they are mandatory.

      • getConfiguration

        StorageActivityConfiguration getConfiguration()
        Gets the configuration of this activity template description that corresponds to the configuration description of this activity template. These configuration values are provided as defaults for this activity template. They 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 attribute overrides and merges with the corresponding parent attribute (configurations from the configuration set and/or Operation.getConfiguration()).

        Returns:
        The configuration values set for this activity template definition 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.

      • getTestConfiguration

        StorageActivityConfiguration getTestConfiguration()
        Gets the test configuration of this activity template definition that corresponds to the configuration description of this activity template definition. These configuration values only apply when the operation is executed in test mode, that is the 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.

        Besides the normal configuration the test configuration overrides and merges (secondly) with the corresponding parent attribute ( test configurations from the configuration set and/or Operation.getTestConfiguration()). That is, the attribute contains only new entries and entries that are changed with respect to the normal configuration and the test configuration of the parent attribute 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 this operation based on the configuration description. If this is an empty configuration, the normal configuration will be used in test mode.

      • getParameters

        Map<String,​StorageActivityModelParameter> getParameters​(ActivityConstants.AccessType accessType)
        Gets the parameters of the designated access type of the operation of this abstract activity. These make up the interface of the operation. The returned map allows for easy storage of the parameters; it maps from parameter name to the corresponding object.
        Parameters are identified by the access type, for instance input or output parameter, and their name.

        The parameters need not be based on parameter templates of this activity template definition or its parent entities.

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

        Parameters:
        accessType - The access type of the parameters to be retrieved (only values in ActivityConstants.AccessType.activityRelatedValues() are allowed).
        Returns:
        The parameters of the operation of this activity template definition for the designated access type (mapped from parameter name to the corresponding parameter). If this operation does not have parameters of the designated type or they are not defined yet (since they may be added later), an empty map will be returned.

      • getParameterTemplates

        Map<String,​StorageParameterTemplate> getParameterTemplates()
        Gets parameter templates that are defined for the operation of this activity template definition or that are changed with respect to the ones of the parent entity.

        This attribute overrides and merges with the corresponding parent attribute (ConfigurationSet.getParameterTemplates() and/or Operation.getParameterTemplates()).

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

      • setClassPath

        void setClassPath​(List<String> classPath)
        Sets the part of the classpath that is added by this activity template definition to the one of the parent attribute. Use null in case this activity template definition does not supplement the classpath of the parent entity.
        Parameters:
        classPath - The part of the classpath that is contributed by this activity template definition. This is appended to the classpath of the parent entity and thus forms the complete classpath.

      • setConfigurationDescription

        void setConfigurationDescription​(StorageConfigurationDescription description)
        Sets the configuration description for this activity template definition. This may change the configuration description of the corresponding executable component description, the operation and the configuration set.
        The configuration description has to be set as a whole; to add or modify single entries, retrieve the complete description from this activity template definition, add or modify the entry and provide the complete description again to this method. Use null to remove it from this activity template definition and inherit the configuration description of the parent entity without any changes.

        This attribute overrides and merges with the corresponding parent attribute ( ConfigurationSet.setConfigurationDescription(InheritedConfigurationDescription) or Operation.setConfigurationDescription(InheritedConfigurationDescription) ).

        Parameters:
        description - The description for all configuration values of this activity template definition, that is, the name of the configuration entries, their type and whether they are mandatory. Use null to remove the configuration description from this activity template definition, that is, it will be inherited from the parent entity again.

      • setConfiguration

        void setConfiguration​(StorageActivityConfiguration configuration)
        Sets the configuration of this activity template definition to the designated one. The provided configuration has to correspond to the configuration description of this activity template definition and parent entities, 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).

        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 activity template definition, that is, it will be inherited from the parent entity again.

        This attribute overrides and merges with the corresponding parent attribute (ConfigurationSet.setConfiguration(InheritedConfiguration) or Operation.setConfiguration(InheritedActivityConfiguration)).

        Parameters:
        configuration - The configuration values set for this activity template definition 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 activity template definition, that is, it will be inherited from the parent entity again.

      • setTestConfiguration

        void setTestConfiguration​(StorageActivityConfiguration testConfiguration)
        Sets the test configuration of the operation of this activity template definition to the designated one. The provided configuration has to correspond to the configuration description of the operation of this activity template definition and its executable component description, that is the values have to have appropriate configuration entries.
        These configuration values only apply when the operation is executed in test mode, that is the operation is provided this configuration instead of the normal configuration. This test configuration is merged with the normal 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 values may also be retrieved from process parameters or the process configuration (determined when modelling).

        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 from this activity template definition, that is, it will be inherited from the parent entity again.

        This attribute overrides and merges with the normal configuration and afterwards with the corresponding parent attribute ( ConfigurationSet.setTestConfiguration(InheritedConfiguration) or Operation.setTestConfiguration(InheritedActivityConfiguration)).

        Parameters:
        testConfiguration - The configuration values set for the test mode of the operation of this activity template definition based on the configuration description. This does not necessarily contain all values since they can still be set when modelling or taken from the normal configuration. Use null to remove the test configuration from this activity template definition, that is, it will be inherited from the parent entity again.

      • setParameters

        void setParameters​(ActivityConstants.AccessType accessType,
                   Map<String,​StorageActivityModelParameter> parameters)
        Sets all the parameters of the designated access type of the operation of this activity template definition. These make up the interface of the operation. Depending on the parameter change policy of this activity template definition, its collection of parameters may be fix, changed and/or added; removal is not allowed. However, the parameter change policy of this activity template definition does not apply to this activity template definition but to its offspring.
        Parameters are identified by the access type, for instance input or output parameter, and their name. Use null for removing all parameter templates of this activity template definition, that is, the parameters will be inherited from the parent entity again.

        The parameters need not be based on parameter templates of this activity template definition or its parent entities.

        This attribute overrides and merges with the corresponding parent attribute (Operation.setParameters(AccessType, InheritedCollection)).

        Parameters:
        accessType - The access type of the parameters to be retrieved (only values in ActivityConstants.AccessType.activityRelatedValues() are allowed).
        parameters - The parameters of the operation of this activity template definition for the designated access type. If the operation does not have parameters of the designated type provide null. This removes overriding parameters and inherits them from the parent entity again.

      • setParameterTemplates

        void setParameterTemplates​(Map<String,​StorageParameterTemplate> parameterTemplates)
        Sets parameter templates that are defined for this activity template definition and its offspring. This may change the parameter templates of the corresponding parent entities or add new parameter templates; removal is not allowed. If you need removal, add a new template and override the description of the one to be removed stating that it should not be used.

        When setting the parameter templates the whole collection has to be set; to add or modify single parameter templates retrieve the complete templates from this activity template definition, add or modify the template and provide the collection of templates again to this method. Use null for removing all parameter templates of this activity template definition, that is, the parameter templates will be inherited from the parent entity again.
        It will not be allowed to set parameter templates for this activity template definition if the parameter change policy of this activity template definition does not allow to add or change real parameters (ParameterChangePolicy.ADD_VIRTUAL or ParameterChangePolicy.FIXED); only null will be accepted. It will not make sense to set parameter templates if the offspring entities are not allowed to add or change parameters.

        This attribute overrides and merges with the corresponding parent attribute (ConfigurationSet.setParameterTemplates(InheritedCollection) or parent attribute).

        Parameters:
        parameterTemplates - A collection containing all parameter templates that are defined for this activity template definition.