Class CustomWrapperInputParameter
java.lang.Object
com.denodo.vdb.engine.customwrapper.CustomWrapperInputParameter
Defines a Custom Wrapper input parameter. Input parameters allow user-defined
configuration values to be passed to a Custom Wrapper.
-
Constructor Summary
ConstructorsConstructorDescriptionCustomWrapperInputParameter
(String name, boolean isMandatory) Deprecated.This method is deprecated since Denodo 5.0.CustomWrapperInputParameter
(String name, boolean isMandatory, boolean isHidden) Deprecated.This method is deprecated since Denodo 5.0.CustomWrapperInputParameter
(String name, String description, boolean isMandatory, boolean isEnvDependent, CustomWrapperInputParameterType type) Constructs aCustomWrapperInputParameter
specifying a name, a description, whether it is mandatory or not and aCustomWrapperInputParameterType
CustomWrapperInputParameter
(String name, String description, boolean isMandatory, CustomWrapperInputParameterType type) Constructs aCustomWrapperInputParameter
specifying a name, a description, whether it is mandatory or not and aCustomWrapperInputParameterType
-
Method Summary
Modifier and TypeMethodDescriptionReturns this input parameter's descriptiongetName()
Returns this input parameter's namegetType()
Returns this input parameter's typeboolean
Returnstrue
if the parameter is dependent on the environmentfalse
otherwise.boolean
isHidden()
Returnstrue
if the parameter is hiddenfalse
otherwise.boolean
Returnstrue
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
Sets this input parameter's name
-
Constructor Details
-
CustomWrapperInputParameter
Deprecated.This method is deprecated since Denodo 5.0. Instead, useCustomWrapperInputParameter(String, String, boolean, CustomWrapperInputParameterType)
Constructs aCustomWrapperInputParameter
specifying a name and whether it is mandatory or not. TheCustomWrapperInputParameter
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.This method is deprecated since Denodo 5.0. Instead, useCustomWrapperInputParameter(String, String, boolean, CustomWrapperInputParameterType)
Constructs aCustomWrapperInputParameter
specifying a name, whether it is mandatory or not and whether it is hidden or not. In case it would not be hidden, theCustomWrapperInputParameter
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 aCustomWrapperInputParameter
specifying a name, a description, whether it is mandatory or not and aCustomWrapperInputParameterType
- 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
- theCustomWrapperInputParameterType
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:
-
CustomWrapperInputParameter
public CustomWrapperInputParameter(String name, String description, boolean isMandatory, boolean isEnvDependent, CustomWrapperInputParameterType type) Constructs aCustomWrapperInputParameter
specifying a name, a description, whether it is mandatory or not and aCustomWrapperInputParameterType
- 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
- theCustomWrapperInputParameterType
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:
-
-
Method Details
-
getName
Returns this input parameter's name- Returns:
- this input parameter's name
-
setName
Sets this input parameter's name- Parameters:
name
- input parameter's name
-
isMandatory
public boolean isMandatory()Returnstrue
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()Returnstrue
if the parameter is dependent on the environmentfalse
otherwise.- Returns:
true
if the parameter is dependent on the environmentfalse
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()Returnstrue
if the parameter is hiddenfalse
otherwise.- Returns:
true
if the parameter is hiddenfalse
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
Returns this input parameter's description- Returns:
- this input parameter's description
-
getType
Returns this input parameter's type- Returns:
- this input parameter's type
-