Interface IParameterDefinition
-
- All Known Implementing Classes:
ParameterDefinition
public interface IParameterDefinitionDefines the parameter definition
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.StringgetDefaultValue()Gets the default valuejava.lang.StringgetDescription()Gets the parameter description.java.lang.StringgetKey()Gets the key.intgetMaxOccurs()Get the max occurs.intgetMinOccurs()Get the min occurs.com.github.toolarium.processing.unit.dto.ParameterValueTypegetValueType()Gets the data typebooleanhasValueToProtect()Check if the value of this parameter should be protected.booleanisEmptyValueAllowed()Check if an empty value is allowed or not.booleanisOptional()Check if the key is optional or not.
-
-
-
Method Detail
-
getKey
java.lang.String getKey()
Gets the key.- Returns:
- the key
-
getValueType
com.github.toolarium.processing.unit.dto.ParameterValueType getValueType()
Gets the data type- Returns:
- the data type
-
getDefaultValue
java.lang.String getDefaultValue()
Gets the default value- Returns:
- the default value
-
isOptional
boolean isOptional()
Check if the key is optional or not.- Returns:
- true if it is optional
-
getMinOccurs
int getMinOccurs()
Get the min occurs.- Returns:
- the min occurs.
-
getMaxOccurs
int getMaxOccurs()
Get the max occurs.- Returns:
- the max occurs.
-
isEmptyValueAllowed
boolean isEmptyValueAllowed()
Check if an empty value is allowed or not.- Returns:
- true if an empty value is allowed
-
hasValueToProtect
boolean hasValueToProtect()
Check if the value of this parameter should be protected.- Returns:
- true if the value of this parameter should be protected; otherwise false.
-
getDescription
java.lang.String getDescription()
Gets the parameter description.- Returns:
- The parameter description
-
-