Package com.carfey.ops.api.bean.job

Class ParameterDefinition

  • public class ParameterDefinition
extends java.lang.Object

    • Constructor Detail

      • ParameterDefinition

        public ParameterDefinition()

    • Method Detail

      • getName

        public java.lang.String getName()

      • setName

        public void setName​(java.lang.String name)

      • isAllowMultiple

        public boolean isAllowMultiple()

      • setAllowMultiple

        public void setAllowMultiple​(boolean allowMultiple)

      • isRequired

        public boolean isRequired()

      • setRequired

        public void setRequired​(boolean required)

      • getValues

        public java.util.List<java.lang.String> getValues()
        Note: May contain references to global parameters (e.g. "{{globalParamName}}), rather than strictly values that match the defined type.
        Returns:
        values

      • setValues

        public void setValues​(java.util.List<java.lang.String> values)

      • withValues

        public ParameterDefinition withValues​(java.util.List<java.lang.String> values)

      • setValidValues

        public void setValidValues​(java.util.List<java.lang.String> validValues)

      • withValidValues

        public ParameterDefinition withValidValues​(java.util.List<java.lang.String> validValues)

      • getValidValues

        public java.util.List<java.lang.String> getValidValues()
        If null, any value is valid.
        Returns:
        valid values
        Since:
        3.3

      • getDefaultValue

        public java.lang.String getDefaultValue()

      • setDefaultValue

        public void setDefaultValue​(java.lang.String defaultValue)

      • withDefaultValue

        public ParameterDefinition withDefaultValue​(java.lang.String defaultValue)

      • isDefined

        public boolean isDefined()

      • setDefined

        public void setDefined​(boolean defined)

      • getDescription

        public java.lang.String getDescription()
        Returns:
        description
        Since:
        4.1

      • setDescription

        public void setDescription​(java.lang.String description)

      • withDescription

        public ParameterDefinition withDescription​(java.lang.String description)

      • setDescriptionHtml

        public void setDescriptionHtml​(java.lang.String descriptionHtml)

      • getUrls

        public java.util.List<java.lang.String> getUrls()
        Since:
        4.9.0

      • setUrls

        public void setUrls​(java.util.List<java.lang.String> urls)
        Since:
        4.9.0

      • withUrls

        public ParameterDefinition withUrls​(java.util.List<java.lang.String> urls)
        Since:
        4.9.0

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object