de.espirit.firstspirit.forms

Interface FormData

All Known Subinterfaces:

IdentifiedFormData, IdProvidingFormData

public interface FormData

Interface definition for form data containers providing direct, generic access to transported values and form information.

Since:

4.2.404

Method Summary

Methods

Modifier and Type	Method and Description
FormField<?>	get(Language language, String fieldName) Provides a property container describing the field with the given name.
GomEditorProvider	getForm() Provides the form definition.

Method Detail

getForm

@NotNull
GomEditorProvider getForm()

Provides the form definition.

Returns:

The form definition.

Since:

4.2.404

get

@NotNull
FormField<?> get(@Nullable
                       Language language,
                       String fieldName)
                 throws NoSuchFormFieldException

Provides a property container describing the field with the given name.

Use getForm().appendEditorNames(null) to get a list of valid field names. For language indepent fields (GomFormElement#usesLanguages() delivers false) one could supply null for the parameter language.

Parameters:

language - The language to get the property for or null for language independent fields.

fieldName - The name of the field to look up.

Returns:

The field's property container.

Throws:

NoSuchFormFieldException - If there is no entry for the given name.

Since:

4.2.404