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

All Superinterfaces:

Public

public interface FormDataProvider
extends Public

Provider for 'external' data. All external data must be wrapped in FormData instances (see the description of FormDataProviderEnvironment for how to do this).

This interface provides the means to query ids and to resolve the data for a list of ids.

Implementing classes must provide a public no-arg constructor. Each instance is initialized with a call to FormDataProvider.init(FormDataProviderEnvironment) after construction.

Since:

4.2.404

Method Summary

List<Long>	find(String query) Find method, delivers a list of ids where the content matches the given query.
List<IdProvidingFormData>	get(List<Long> ids) Return the values for the specified ids.
void	init(FormDataProviderEnvironment environment) Init the provider instance.

Method Detail

init

void init(@NotNull
          FormDataProviderEnvironment environment)

Init the provider instance. Called before any other method.

Since:

4.2.404

get

@NotNull
List<IdProvidingFormData> get(@NotNull
                                      List<Long> ids)

Return the values for the specified ids. Implementers may use FormDataProviderEnvironment.createEmpty(de.espirit.firstspirit.access.store.templatestore.gom.GomEditorProvider) to create FormData instances.

Parameters:

ids - List of ids.

Returns:

List of FormData instances.

Since:

4.2.431

find

@NotNull
List<Long> find(String query)

Find method, delivers a list of ids where the content matches the given query. The implementation is responsible to limit the amount of the returned ids in a sensible way. The response for a null query is implementation specific, e.g. it may deliver the 'newest' 500 entries.

Parameters:

query - A provider specific query or null.

Returns:

a list of keys of matches

Since:

4.2.431