Package com.orchestranetworks.addon.dint.transformation

Class ParameterDefinition

java.lang.Object

com.orchestranetworks.addon.dint.transformation.ParameterDefinition

public final class ParameterDefinition
extends java.lang.Object

The definition of a transformation's parameter.

Since:

4.1.0

See Also:

TransformationDefinition.getParameterDefinitions()

Constructor Summary

Constructors

Constructor	Description
ParameterDefinition(java.lang.String name, com.onwbp.base.text.UserMessage label)	Constructs a new ParameterDefinition.
ParameterDefinition(java.lang.String name, com.onwbp.base.text.UserMessage label, com.onwbp.base.text.UserMessage description, java.lang.String defaultValue)	Constructs a new ParameterDefinition.

Method Summary

Modifier and Type	Method	Description
DataType	getDataType()	Returns the data type.
java.lang.String	getDefaultValue()	Returns the default value.
com.onwbp.base.text.UserMessage	getDescription()	Returns the description.
com.onwbp.base.text.UserMessage	getLabel()	Returns the label.
java.lang.String	getName()	Returns the unique name.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ParameterDefinition

public ParameterDefinition(java.lang.String name,
                           com.onwbp.base.text.UserMessage label)

Constructs a new ParameterDefinition.

Parameters:

name - the unique name.

label - the label.

ParameterDefinition

public ParameterDefinition(java.lang.String name,
                           com.onwbp.base.text.UserMessage label,
                           com.onwbp.base.text.UserMessage description,
                           java.lang.String defaultValue)

Constructs a new ParameterDefinition.

Parameters:

name - the unique name.

label - the label.

description - the description.

defaultValue - the default value.

Method Detail

getName

public java.lang.String getName()

Returns the unique name.

getLabel

public com.onwbp.base.text.UserMessage getLabel()

Returns the label.

getDescription

public com.onwbp.base.text.UserMessage getDescription()

Returns the description.

getDefaultValue

public java.lang.String getDefaultValue()

Returns the default value.

getDataType

public DataType getDataType()

Returns the data type.

Limitation: Only support String data type DefaultDataTypes.STRING