Package de.xima.fc.form.common.models

Class XValidationParams

java.lang.Object

de.xima.fc.form.common.models.XValidationParams

All Implemented Interfaces:

IXBaseValidationParams, IXValidationParams, Serializable

public class XValidationParams
extends Object
implements IXValidationParams

Simple POJO implementation of IXValidationParams.

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
XValidationParams(List<String[]> values, Map<String,List<String[]>> valuesMap, int ordinalIndex, Map<String,? extends IFormContainerMetaData> dynContainerMap, IXItemPropertiesData xItemPropertiesData, IXFormRenderConfig formRenderConfig, Map<Serializable,Serializable> frqSessionAttributes, long clientId)	Creates a new params object with the given data.

Method Summary

Modifier and Type	Method	Description
long	getClientId()
Map<String,? extends IFormContainerMetaData>	getDynContainerMap()
String[]	getElementValues()
Map<String,List<String[]>>	getFieldValuesMap()
IXFormRenderConfig	getFormRenderConfig()
Map<Serializable,Serializable>	getFRQSessionAttributes()
String	getI18nValue(String i18nKey)
int	getOrdinalIndex()
int	getRepetitionIndex()
List<String[]>	getValues()
List<String[]>	getValues(String key)
IXItemPropertiesData	getXItemPropertiesData()
boolean	isShouldValidate()	When designing a form, the user can choose whether the form should be validated when the a submit button is pressed.
boolean	isValuesEmpty(List<String[]> values)

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.xima.fc.form.common.models.IXBaseValidationParams

getClientId, getDynContainerMap, getFieldValuesMap, getFormRenderConfig, getFRQSessionAttributes, getI18nValue, getLocale, getValues, isShouldValidate, isValuesEmpty

Constructor Detail

XValidationParams

public XValidationParams(List<String[]> values,
                         Map<String,List<String[]>> valuesMap,
                         int ordinalIndex,
                         Map<String,? extends IFormContainerMetaData> dynContainerMap,
                         IXItemPropertiesData xItemPropertiesData,
                         IXFormRenderConfig formRenderConfig,
                         Map<Serializable,Serializable> frqSessionAttributes,
                         long clientId)

Creates a new params object with the given data.

Parameters:

values - The value for IXValidationParams.getValues().

valuesMap - The value for IXBaseValidationParams.getFieldValuesMap().

ordinalIndex - The 0-based ordinal index of the element repetition.

dynContainerMap - The value for IXBaseValidationParams.getDynContainerMap().

xItemPropertiesData - The value for IXValidationParams.getXItemPropertiesData().

formRenderConfig - The value for IXBaseValidationParams.getFormRenderConfig().

frqSessionAttributes - The value for IXBaseValidationParams.getFRQSessionAttributes().

clientId - The value for IXBaseValidationParams.getClientId().

Method Detail

getValues

public List<String[]> getValues()

Specified by:

getValues in interface IXValidationParams

Returns:

The values that were submitted for this form item.

getXItemPropertiesData

public IXItemPropertiesData getXItemPropertiesData()

Specified by:

getXItemPropertiesData in interface IXValidationParams

Returns:

A wrapper object for accessing the properties (XPropertyEnum) of the form item to validate.

getElementValues

public String[] getElementValues()

Specified by:

getElementValues in interface IXValidationParams

Returns:

The values that were submitted for this form item, for the current IXValidationParams.getRepetitionIndex(). When not a repeated element, this returns the values for the element.

getRepetitionIndex

public int getRepetitionIndex()

Specified by:

getRepetitionIndex in interface IXValidationParams

Returns:

When the form field is a repeated element: the repetition index (which may neither start at 0 nor is it necessarily continuous) of the current repetition. When not a repeated element, this returns -1.

getOrdinalIndex

public int getOrdinalIndex()

Specified by:

getOrdinalIndex in interface IXValidationParams

Returns:

When the form field is a repeated element: the 0-based oridnal index of the current repetition. When not a repeated element, this returns -1.

getI18nValue

public String getI18nValue(String i18nKey)

Specified by:

getI18nValue in interface IXBaseValidationParams

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.

getClientId

public long getClientId()

Specified by:

getClientId in interface IXBaseValidationParams

Returns:

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

getFieldValuesMap

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

Specified by:

getFieldValuesMap in interface IXBaseValidationParams

Returns:

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

getFormRenderConfig

public IXFormRenderConfig getFormRenderConfig()

Specified by:

getFormRenderConfig in interface IXBaseValidationParams

Returns:

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

getValues

public List<String[]> getValues(String key)

Specified by:

getValues in interface IXBaseValidationParams

Parameters:

key - Name of a form field.

Returns:

All values that were submitted for the given for the given form field name. The list contains multiple items when the form field is repeated; the array contains multiple items when the form field submitted multiple values (e.g. a select element with multiple set).

getFRQSessionAttributes

public Map<Serializable,Serializable> getFRQSessionAttributes()

Specified by:

getFRQSessionAttributes in interface IXBaseValidationParams

Returns:

All attributes from the current form request session.

isValuesEmpty

public boolean isValuesEmpty(List<String[]> values)

Specified by:

isValuesEmpty in interface IXBaseValidationParams

Parameters:

values - List of values of a form field.

Returns:

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

getDynContainerMap

public Map<String,? extends IFormContainerMetaData> getDynContainerMap()

Specified by:

getDynContainerMap in interface IXBaseValidationParams

Returns:

A map with the meta data for repeated elements. The key is the name of a form field.

isShouldValidate

public boolean isShouldValidate()

Description copied from interface: IXBaseValidationParams

When designing a form, the user can choose whether the form should be validated when the a submit button is pressed. This returns true when a submit button was pressed that requires the form to be validated, and false. In general, no validation should be performed when this is false. However, there are some use cases when validation needs to be performed no matter the circumstances. In that case, this flag may be ignored.

Specified by:

isShouldValidate in interface IXBaseValidationParams

Returns:

Whether the form should be validated.