PluginValidationRuleValidateRetVal.Builder (formcycle: bom 8.5.6 API)

java.lang.Object
- de.xima.fc.interfaces.plugin.retval.validation.PluginValidationRuleValidateRetVal.Builder

Enclosing class:

PluginValidationRuleValidateRetVal
```
public static final class PluginValidationRuleValidateRetVal.Builder
extends Object
```
A builder for plugin validation rule validation return values.

Since:

8.5.4

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`PluginValidationRuleValidateRetVal`	`build()`	Creates a new plugin validation rule validation return value instance with the current state of this builder.
`PluginValidationRuleValidateRetVal.Builder`	`message(String message)`	Sets the validation message to display, in case the validated value is not `valid` according to the validation logic.
`PluginValidationRuleValidateRetVal.Builder`	`valid(boolean valid)`	Sets whether the validated value is valid according to the validation logic.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - build
```
public PluginValidationRuleValidateRetVal build()
```
    Creates a new plugin validation rule validation return value instance with the current state of this builder.
    
    Returns:
    
    A new plugin validation rule validation return value instance.
  - message
```
public PluginValidationRuleValidateRetVal.Builder message(String message)
```
    Sets the validation message to display, in case the validated value is not valid according to the validation logic. Has no effect if the validated value is valid. When null or empty, uses the default validation message, either from the validation rule or as overwritten in the form designer.
    
    Parameters:
    
    message - The validation message to display, or null if no message should be displayed.
    
    Returns:
    
    This builder for chaining.
  - valid
```
public PluginValidationRuleValidateRetVal.Builder valid(boolean valid)
```
    Sets whether the validated value is valid according to the validation logic. Defaults to false.
    
    Parameters:
    
    valid - True if the value is valid, false otherwise.
    
    Returns:
    
    This builder instance for chaining.