de.aristaflow.adept2.model.activitymodel

Interface StorageExecutableComponentDescription

All Superinterfaces:

AbstractExecutableComponentDescription, PluginDataContainer, UserAttributeContainer

public interface StorageExecutableComponentDescription
extends AbstractExecutableComponentDescription

This interface provides the means to store an ExecutableComponentDescription which is supported by not inheriting any attributes from a parent parameter (in contrast to the interface ExecutableComponentDescription. 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:

ExecutableComponentDescription

Method Summary

Modifier and Type	Method and Description
StorageConfigurationDescription	getConfigurationDescription() Gets the configuration description for this executable component description without any inherited values.
java.util.Map<java.lang.String,StorageParameterTemplate>	getParameterTemplates() Gets parameter templates that are defined for this executable component description and its child entities for storage.
void	setConfigurationDescription(StorageConfigurationDescription description) Sets the configuration description for this executable component description.
void	setParameterTemplates(java.util.Collection<StorageParameterTemplate> parameterTemplates) Sets parameter templates that are defined for this executable component description and its child entities.

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

getClassLoaderUsage, getClassPath, getDeveloperDescription, getExecutionControlProperties, getGUIContextID, getIconID, getImplementationClass, getLicenceInformation, getName, getRevision, getState, getSystemComponent, setClassLoaderUsage, setClassPath, setDeveloperDescription, setExecutionControlProperties, setGUIContextID, setIconID, setImplementationClass, setLicenceInformation, setName, setSystemComponent

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 executable component description without any inherited values.

Returns:

The description for all configuration values of this executable component description, that is, the name of the configuration entries, their type and whether they are mandatory.

See Also:

ExecutableComponentDescription.getConfigurationDescription()

getParameterTemplates

java.util.Map<java.lang.String,StorageParameterTemplate> getParameterTemplates()

Gets parameter templates that are defined for this executable component description and its child entities for storage.

Returns:

Templates for parameters (mapped from parameter template name to the corresponding parameter template) that may be added to child entities of this executable component. If no parameter templates are defined, an empty map will be returned.

setConfigurationDescription

void setConfigurationDescription(StorageConfigurationDescription description)

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

Parameters:

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

setParameterTemplates

void setParameterTemplates(java.util.Collection<StorageParameterTemplate> parameterTemplates)

Sets parameter templates that are defined for this executable component description and its child entities.

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.

Parameters:

parameterTemplates - A collection containing all parameter templates that are defined for this executable component description and its child entities. Use null to remove all parameter templates.