Class PluginValidationRuleValidateParams

java.lang.Object

de.xima.fc.interfaces.plugin.param.validation.PluginValidationRuleValidateParams

All Implemented Interfaces:

Serializable

public final class PluginValidationRuleValidateParams
extends Object
implements Serializable

Parameters 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 final class	PluginValidationRuleValidateParams.Builder	A builder for plugin validation rule validation parameters.

Method Summary

Modifier and Type	Method	Description
static PluginValidationRuleValidateParams.Builder	builder()	Creates a new builder for plugin validation rule validation parameters.
String	defaultMessage()	Gets the default validation message, either from the validation rule or as overwritten in the form designer.
IXItemPropertiesData	item()	Gets the properties of the form item being validated.
Locale	locale()	Gets the locale for locale-sensitive operations, e.g. the language of the form being validated.
int	repetitionIndex()	Gets the repetition index for repeated items. -1 for non-repeated items.
String	value()	Gets the value to validate.

Methods inherited from class Object

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

Method Details

defaultMessage

public String defaultMessage()

Gets the default validation message, either from the validation rule or as overwritten in the form designer.

Returns:

The default validation message, never null or empty.

item

public IXItemPropertiesData item()

Gets the properties of the form item being validated.

Returns:

The properties of the form item being validated.

locale

public Locale locale()

Gets the locale for locale-sensitive operations, e.g. the language of the form being validated.

Returns:

The locale for locale-sensitive operations.

repetitionIndex

public int repetitionIndex()

Gets the repetition index for repeated items. -1 for non-repeated items.

Returns:

The repetition index for repeated items, or -1 for non-repeated items.

value

public String value()

Gets the value to validate.

Returns:

The value to validate.

builder

public static PluginValidationRuleValidateParams.Builder builder()

Creates a new builder for plugin validation rule validation parameters.

Returns:

A new builder instance.