Package com.orchestranetworks.addon.dqid

Class ParameterConstraint

  • public final class ParameterConstraint
extends java.lang.Object
    The definition of a constraint for the value of a parameter.
    Since:
    1.4.0
    See Also:
    ParameterDefinition

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getMaxValue()
      Returns the maximum value.
      java.lang.String getMinValue()
      Returns the minimum value.
      boolean isNegativeSupported()
      Returns true if the data type is Number and negative values are allowed.
      boolean isUnboundedSupported()
      Returns true if the data type is Number, and the unbounded value is allowed.
      boolean isUndefinedValueSupported()
      Returns true if the data type is Boolean, and undefined values are allowed.
      void setMaxValue​(java.lang.String maxValue)
      Defines the maximum value allowed for this parameter.
      void setMinValue​(java.lang.String minValue)
      Defines the minimum value allowed for this parameter.
      void setNegativeSupported​(boolean negativeSupported)
      Sets negative number support when the data type is Number.
      void setUnboundedSupported​(boolean unboundedSupported)
      Sets unbounded value support when the data type is Number.
      void setUndefinedValueSupported​(boolean undefinedValueSupported)
      Sets undefined value support when the data type is Boolean.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • ParameterConstraint

        public ParameterConstraint()

    • Method Detail

      • isUndefinedValueSupported

        public boolean isUndefinedValueSupported()
        Returns true if the data type is Boolean, and undefined values are allowed.

      • setUndefinedValueSupported

        public void setUndefinedValueSupported​(boolean undefinedValueSupported)
        Sets undefined value support when the data type is Boolean.
        Parameters:
        undefinedValueSupported - boolean. Default value: false.

      • isNegativeSupported

        public boolean isNegativeSupported()
        Returns true if the data type is Number and negative values are allowed.

      • setNegativeSupported

        public void setNegativeSupported​(boolean negativeSupported)
        Sets negative number support when the data type is Number.
        Parameters:
        negativeSupported - boolean. Default value: false.

      • isUnboundedSupported

        public boolean isUnboundedSupported()
        Returns true if the data type is Number, and the unbounded value is allowed.

      • setUnboundedSupported

        public void setUnboundedSupported​(boolean unboundedSupported)
        Sets unbounded value support when the data type is Number.
        Parameters:
        unboundedSupported - boolean. Default value: false.

      • getMinValue

        public java.lang.String getMinValue()
        Returns the minimum value.

      • setMinValue

        public void setMinValue​(java.lang.String minValue)
        Defines the minimum value allowed for this parameter.
        Parameters:
        minValue - It depends on the data type of parameter and it must be formatted by the rule that is defined by the add-on.
        If it is not compatible with this parameter, it's considered as no value, and this property will not be used.
        See Also:
        FormatDataPolicy, DataTypeFormat

      • getMaxValue

        public java.lang.String getMaxValue()
        Returns the maximum value.

      • setMaxValue

        public void setMaxValue​(java.lang.String maxValue)
        Defines the maximum value allowed for this parameter.
        Parameters:
        maxValue - It depends on the data type of parameter and it must be formatted by the rule that is defined by the add-on.
        If it is not compatible with parameter, it's considered as no value, and this property will not be used.
        See Also:
        FormatDataPolicy, DataTypeFormat