de.espirit.firstspirit.access.editor.fslist
Interface FormDataProviderEnvironment

public interface FormDataProviderEnvironment

Environment, provided at FormDataProvider.init(FormDataProviderEnvironment).

Since:

4.2.404

Method Summary

IdProvidingFormData	createEmpty(GomEditorProvider form) Create an empty IdProvidingFormData instance for the specified form.
GomEditorProvider	createGomEditorProvider(String xml) Create a GomEditorProvider for the specified form definition.
Map<String,String>	getParams() Delivers the generic paramters defined in the form.
SpecialistsBroker	getSpecialistsBroker() Starting point for requesting services or providers.

Method Detail

getSpecialistsBroker

@NotNull
SpecialistsBroker getSpecialistsBroker()

Starting point for requesting services or providers.

Returns:

A specialist broker instance.

Since:

4.2.404

getParams

@NotNull
Map<String,String> getParams()

Delivers the generic paramters defined in the form.

Returns:

A non-modifiable map of parameters which are defined in the form.

Since:

4.2.404

createGomEditorProvider

@NotNull
GomEditorProvider createGomEditorProvider(String xml)

Create a GomEditorProvider for the specified form definition.

You can use this to create an empty FormData instance: env.createEmpty(env.createGomEditorProvider(xml)).

You should cache the instance for repeated FormDataProviderEnvironment.createEmpty(GomEditorProvider) calls.

Parameters:

xml - Form definition.

Returns:

the newly created provider

Since:

4.2.404

See Also:

FormDataProviderEnvironment.createEmpty(GomEditorProvider)

createEmpty

@NotNull
IdProvidingFormData createEmpty(GomEditorProvider form)

Create an empty IdProvidingFormData instance for the specified form. The instance could be manipulated without further restrictions (despite the restrictions provided by the form itself). The caller is responsible to set the unique id on the returned instance before the returned instance is exposed by FormDataProvider.get(java.util.List).

Parameters:

form - the newly created empty form

Since:

4.2.431

See Also:

FormDataProviderEnvironment.createGomEditorProvider(String)