Class PluginValidationRuleValidateParams.Builder

java.lang.Object
de.xima.fc.interfaces.plugin.param.validation.PluginValidationRuleValidateParams.Builder
Enclosing class:
PluginValidationRuleValidateParams
public static final class PluginValidationRuleValidateParams.Builder extends Object
A builder for plugin validation rule validation parameters.
Since:
8.5.4

  • Method Details

    • build

      public PluginValidationRuleValidateParams build()
      Creates a new plugin validation rule validation parameters instance with the current state of this builder.
      Returns:
      A new plugin validation rule validation parameters instance.

    • defaultMessage

      public PluginValidationRuleValidateParams.Builder defaultMessage(String defaultMessage)
      Sets the default validation message for the validation parameters. Should be set, if not set, uses a generic default message.
      Parameters:
      defaultMessage - The default validation message.
      Returns:
      This builder instance for chaining.

    • item

      public PluginValidationRuleValidateParams.Builder item(IXItemPropertiesData item)
      Sets the properties of the form item being validated. This is required.
      Parameters:
      item - The properties of the form item being validated.
      Returns:
      This builder instance for chaining.

    • locale

      public PluginValidationRuleValidateParams.Builder locale(Locale locale)
      Sets the locale for locale-sensitive operations, e.g. the language of the form being validated. Defaults to English.
      Parameters:
      locale - The locale for locale-sensitive operations.
      Returns:
      This builder instance for chaining.

    • repetitionIndex

      public PluginValidationRuleValidateParams.Builder repetitionIndex(int repetitionIndex)
      Sets the repetition index for repeated items. -1 for non-repeated items. Defaults to -1.
      Parameters:
      repetitionIndex - The repetition index for repeated items, or -1 for non-repeated items.
      Returns:
      This builder instance for chaining.

    • value

      public PluginValidationRuleValidateParams.Builder value(String value)
      Sets the value to validate. Default to an empty string if not set.
      Parameters:
      value - The value to validate.
      Returns:
      This builder instance for chaining.