de.aristaflow.adept2.model.activitymodel

Interface StorageActivityModelParameter

All Superinterfaces:

AbstractActivityModelParameter, PluginDataContainer, UserAttributeContainer

public interface StorageActivityModelParameter
extends AbstractActivityModelParameter

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.

Author:

Ulrich Kreher

See Also:

ActivityModelParameter

Method Summary

Modifier and Type	Method and Description
StorageActivityConfiguration	getConfiguration() Gets the configuration of this activity model parameter that corresponds to the configuration description of this activity model parameter without any inherited values.
StorageConfigurationDescription	getConfigurationDescription() Gets the configuration description for this activity model parameter without any inherited values.
void	setConfiguration(StorageActivityConfiguration configuration) Sets the configuration for this activity model parameter.
void	setConfigurationDescription(StorageConfigurationDescription description) Sets the configuration description for this activity model parameter.

Methods inherited from interface de.aristaflow.adept2.model.activitymodel.AbstractActivityModelParameter

getDataType, getDefaultValue, getDescription, getDeveloperDescription, getIdentifierID, getName, getUDTName, isDataTypeInherited, isDefaultValueInherited, isDescriptionInherited, isDeveloperDescriptionInherited, isFailure, isFailureInherited, isIdentifierIDInherited, isOptional, isOptionalInherited, isVirtual, isVirtualInherited, removeOwnDataType, removeOwnDefaultValue, removeOwnDescription, removeOwnDeveloperDescription, removeOwnFailure, removeOwnIdentifierID, removeOwnOptional, removeOwnVirtual, setDataType, setDefaultValue, setDescription, setDeveloperDescription, setFailure, setIdentifierID, setName, setOptional, setVirtual

Methods inherited from interface de.aristaflow.adept2.model.common.UserAttributeContainer

getUserAttributes, getUserAttributeValue, removeUserAttributeValue, setUserAttributeValue

Methods inherited from interface de.aristaflow.adept2.model.common.PluginDataContainer

getPluginData, getPluginDatas, getSupportedPlugins

Method Detail

getConfigurationDescription

StorageConfigurationDescription getConfigurationDescription()

Gets the configuration description for this activity model parameter without any inherited values.

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 activity model parameter, 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:

ActivityModelParameter.getConfigurationDescription()

getConfiguration

StorageActivityConfiguration getConfiguration()

Gets the configuration of this activity model parameter that corresponds to the configuration description of this activity model parameter 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 this activity model parameter 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 this activity model parameter. The configuration description has to be set as a whole; to add or modify single entries, retrieve the complete description from this activity model parameter, add or modify the entry and provide the complete description again to this method. Use null to remove it from this activity model parameter 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 this activity model parameter, 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 (if existing). Use null to remove the configuration description.

setConfiguration

void setConfiguration(StorageActivityConfiguration 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 parent (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 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 configuration values set for this activity model parameter 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.