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 provided as IdentifiedFormData. One may use the FormsAgent to get hold of a generic identified form data container.

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

Important: Implementing classes must provide a public no-arg constructor. After construction, an instance will be initialized before any other method gets called.

Since:

4.2.404

Method Summary

Methods

Modifier and Type	Method and Description
List<Long>	find(String query) Find method, delivers a list of ids where the content matches the given query.
List<IdentifiedFormData>	get(List<Long> ids) Return the values for the specified ids.
void	init(FormDataProviderContext context) Initializes the provider instance.

Method Detail

init

void init(@NotNull
        FormDataProviderContext context)

Initializes the provider instance. Called before any other method.

Parameters:

context - The context for providing form data.

Since:

5.0.100

get

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

Return the values for the specified ids.

Parameters:

ids - List of ids.

Returns:

List of IdentifiedFormData instances.

Since:

5.0.100

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