PluginValidationRuleValidateRetVal (formcycle: bom 8.5.6 API)

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

All Implemented Interfaces:

Serializable
```
public final class PluginValidationRuleValidateRetVal
extends Object
implements Serializable
```
Return value for the validate method of validation rule plugins.

Since:

8.5.4

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class PluginValidationRuleValidateRetVal.Builder
A builder for plugin validation rule validation return values.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static PluginValidationRuleValidateRetVal.Builder`	`builder()`	Creates a new builder for plugin validation rule validation return values.
`String`	`message()`	Gets the validation message to display, in case the validated value is not `valid` according to the validation logic.
`static PluginValidationRuleValidateRetVal`	`ofValid()`	Gets plugin validation rule return value indicating that the validated value is valid according to the validation logic, and does not contain any other optional data.
`boolean`	`valid()`	Gets 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
  - message
```
public String message()
```
    Gets 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.
    
    Returns:
    
    The validation message to display, or null if no message should be displayed.
  - valid
```
public boolean valid()
```
    Gets whether the validated value is valid according to the validation logic.
    
    Returns:
    
    True if the value is valid, false otherwise.
  - builder
```
public static PluginValidationRuleValidateRetVal.Builder builder()
```
    Creates a new builder for plugin validation rule validation return values.
    
    Returns:
    
    A new builder instance.
  - ofValid
```
public static PluginValidationRuleValidateRetVal ofValid()
```
    Gets plugin validation rule return value indicating that the validated value is valid according to the validation logic, and does not contain any other optional data.
    
    Returns:
    
    A form datatype validation logic return value indicating a valid value.