com.denodo.vdb.engine.customwrapper

Class CustomWrapperInputParameter

java.lang.Object

com.denodo.vdb.engine.customwrapper.CustomWrapperInputParameter

public final class CustomWrapperInputParameter
extends Object

Defines a Custom Wrapper input parameter. Input parameters allow user-defined configuration values to be passed to a Custom Wrapper.

Constructor Summary

Constructors

Constructor and Description
CustomWrapperInputParameter(String name, boolean isMandatory) Deprecated. This method is deprecated since Denodo 5.0. Instead, use CustomWrapperInputParameter(String, String, boolean, CustomWrapperInputParameterType)
CustomWrapperInputParameter(String name, boolean isMandatory, boolean isHidden) Deprecated. This method is deprecated since Denodo 5.0. Instead, use CustomWrapperInputParameter(String, String, boolean, CustomWrapperInputParameterType)
CustomWrapperInputParameter(String name, String description, boolean isMandatory, boolean isEnvDependent, CustomWrapperInputParameterType type) Constructs a CustomWrapperInputParameter specifying a name, a description, whether it is mandatory or not and a CustomWrapperInputParameterType
CustomWrapperInputParameter(String name, String description, boolean isMandatory, CustomWrapperInputParameterType type) Constructs a CustomWrapperInputParameter specifying a name, a description, whether it is mandatory or not and a CustomWrapperInputParameterType

Method Summary

Modifier and Type	Method and Description
String	getDescription() Returns this input parameter's description
String	getName() Returns this input parameter's name
CustomWrapperInputParameterType	getType() Returns this input parameter's type
boolean	isEnvDependent() Returns true if the parameter is dependent on the environment false otherwise.
boolean	isHidden() Returns true if the parameter is hidden false otherwise.
boolean	isMandatory() Returns true if this input parameter is mandatory, false otherwise.
void	setEnvDependent(boolean isEnvDependent) Sets whether this input parameter is dependent on the environment or not.
void	setHidden(boolean hidden) Sets whether this input parameter is hidden or not.
void	setMandatory(boolean isMandatory) Sets whether this input parameter is mandatory or not.
void	setName(String name) Sets this input parameter's name

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomWrapperInputParameter

@Deprecated
public CustomWrapperInputParameter(String name,
                                                boolean isMandatory)

Deprecated. This method is deprecated since Denodo 5.0. Instead, use CustomWrapperInputParameter(String, String, boolean, CustomWrapperInputParameterType)

Constructs a CustomWrapperInputParameter specifying a name and whether it is mandatory or not. The CustomWrapperInputParameter will accept arbitrary long text values.

Parameters:

name - the name for this input parameter.

isMandatory - true if this input parameter is mandatory, false otherwise.

CustomWrapperInputParameter

@Deprecated
public CustomWrapperInputParameter(String name,
                                                boolean isMandatory,
                                                boolean isHidden)

Deprecated. This method is deprecated since Denodo 5.0. Instead, use CustomWrapperInputParameter(String, String, boolean, CustomWrapperInputParameterType)

Constructs a CustomWrapperInputParameter specifying a name, whether it is mandatory or not and whether it is hidden or not. In case it would not be hidden, the CustomWrapperInputParameter will accept arbitrary long text values.

Parameters:

name - the name for this input parameter.

isMandatory - true if this input parameter is mandatory, false otherwise.

isHidden - true, if the parameter is sensitive and should be hidden

CustomWrapperInputParameter

public CustomWrapperInputParameter(String name,
                                   String description,
                                   boolean isMandatory,
                                   CustomWrapperInputParameterType type)

Constructs a CustomWrapperInputParameter specifying a name, a description, whether it is mandatory or not and a CustomWrapperInputParameterType

Parameters:

name - the name for this input parameter.

description - a description that will appear as a tooltip in the Admin Tool.

isMandatory - true if this input parameter is mandatory, false otherwise.

type - the CustomWrapperInputParameterType of this input parameter. The type of the parameter limits the values accepted for the input parameter. According to this type, the Admin Tool will represent the input parameter with an appropriate visual component.

See Also:

CustomWrapperInputParameterTypeFactory

CustomWrapperInputParameter

public CustomWrapperInputParameter(String name,
                                   String description,
                                   boolean isMandatory,
                                   boolean isEnvDependent,
                                   CustomWrapperInputParameterType type)

Constructs a CustomWrapperInputParameter specifying a name, a description, whether it is mandatory or not and a CustomWrapperInputParameterType

Parameters:

name - the name for this input parameter.

description - a description that will appear as a tooltip in the Admin Tool.

isMandatory - true if this input parameter is mandatory, false otherwise.

isEnvDependent - true if this input parameter is dependent on the environment, false otherwise.

type - the CustomWrapperInputParameterType of this input parameter. The type of the parameter limits the values accepted for the input parameter. According to this type, the Admin Tool will represent the input parameter with an appropriate visual component.

See Also:

CustomWrapperInputParameterTypeFactory

Method Detail

getName

public String getName()

Returns this input parameter's name

Returns:

this input parameter's name

setName

public void setName(String name)

Sets this input parameter's name

Parameters:

name - input parameter's name

isMandatory

public boolean isMandatory()

Returns true if this input parameter is mandatory, false otherwise.

Returns:

true if this input parameter is mandatory, false otherwise.

setMandatory

public void setMandatory(boolean isMandatory)

Sets whether this input parameter is mandatory or not.

Parameters:

isMandatory - true if this input parameter is mandatory, false otherwise.

isEnvDependent

public boolean isEnvDependent()

Returns true if the parameter is dependent on the environment false otherwise.

Returns:

true if the parameter is dependent on the environment false otherwise.

setEnvDependent

public void setEnvDependent(boolean isEnvDependent)

Sets whether this input parameter is dependent on the environment or not.

Parameters:

isEnvDependent - true is dependent on the environment, false otherwise.

isHidden

public boolean isHidden()

Returns true if the parameter is hidden false otherwise.

Returns:

true if the parameter is hidden false otherwise.

setHidden

public void setHidden(boolean hidden)

Sets whether this input parameter is hidden or not.

Parameters:

hidden - true if the parameter is sensitive and should be hidden, false otherwise.

getDescription

public String getDescription()

Returns this input parameter's description

Returns:

this input parameter's description

getType

public CustomWrapperInputParameterType getType()

Returns this input parameter's type

Returns:

this input parameter's type