Package de.espirit.firstspirit.forms

Interface RemoteFormData

All Superinterfaces:

FormData

public interface RemoteFormData
extends FormData

Interface definition for form data containers providing remote, generic access to transported values and form information. It differs from FormData in that remote form fields are provided.

Since:

5.0.102

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	RemoteFormData.InaccessibleException	Thrown to indicate that a field is not accessible.

Method Summary

Modifier and Type	Method	Description
@NotNull RemoteFormField<?>	get(@Nullable Language language, String fieldName)	Provides a property container describing the field with the given name.

Methods inherited from interface de.espirit.firstspirit.forms.FormData

getForm

Method Details

get

@NotNull
@NotNull RemoteFormField<?> get(@Nullable
 @Nullable Language language,
 String fieldName)
                         throws NoSuchFormFieldException,
RemoteFormData.InaccessibleException

Provides a property container describing the field with the given name.
Use FormData.getForm().appendEditorNames(null) to get a list of valid field names. For language indepent fields (GomFormElement#usesLanguages() delivers false) one can supply null for the parameter language.

Specified by:

get in interface FormData

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.

RemoteFormData.InaccessibleException - If the requested field is not accessible.

Since:

5.0.102