de.xima.fc.form.common.models

Interface IXBaseValidationParams

All Superinterfaces:

Serializable

All Known Subinterfaces:

IXGlobalValidationParams, IXValidationParams

All Known Implementing Classes:

XGlobalValidationParams, XValidationParams

public interface IXBaseValidationParams
extends Serializable

Base interface with common methods for both IXValidationParams and IXGlobalValidationParams.

Since:

6.6.3

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method and Description
long	getClientId()
Map<String,List<String[]>>	getFieldValuesMap()
IXFormRenderConfig	getFormRenderConfig()
Map<Serializable,Serializable>	getFRQSessionAttributes()
String	getI18nValue(String i18nKey)
default Locale	getLocale()
List<String[]>	getValues(String key)
boolean	isValuesEmpty(List<String[]> values)

Method Detail

getClientId

long getClientId()

Returns:

The ID of the current client to which the form belongs.

getFieldValuesMap

Map<String,List<String[]>> getFieldValuesMap()

Returns:

A map with all values that were submitted. The key is the name of a form field.

getFormRenderConfig

IXFormRenderConfig getFormRenderConfig()

Returns:

The current form render config for accessing the global configuration of the validation process.

getFRQSessionAttributes

Map<Serializable,Serializable> getFRQSessionAttributes()

Returns:

All attributes from the current form request session.

getI18nValue

String getI18nValue(String i18nKey)

Parameters:

i18nKey - I18n key for the localized message.

Returns:

The localized message for the given key, retrieved from the built-in resource bundle. Plugin resource bundles are not considered.

getLocale

default Locale getLocale()

Returns:

The current locale to be used for creating error messages.

getValues

List<String[]> getValues(String key)

isValuesEmpty

boolean isValuesEmpty(List<String[]> values)

Parameters:

values - List of values of a form field.

Returns:

true if the values are all empty, or false otherwise.