Package com.foreach.across.modules.entity.autosuggest

Interface AutoSuggestDataSet

All Known Implementing Classes:

InitializingAutoSuggestDataSet, SimpleAutoSuggestDataSet

public interface AutoSuggestDataSet

Since:

3.4.0

Author:

Arne Vandamme

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	AutoSuggestDataSet.Result	Represents a single auto-suggest result.
static interface	AutoSuggestDataSet.ResultTransformer	Optional interface to be implemented by dataset implementations to indicate its possible to generate a single auto-suggest result for an object.

Method Summary

Modifier and Type	Method	Description
static SimpleAutoSuggestDataSet.SimpleAutoSuggestDataSetBuilder	builder()	Create a builder for a simple dataset.
static InitializingAutoSuggestDataSet.InitializingAutoSuggestDataSetBuilder	forControl()
boolean	isPrefetchSupported()
Object	prefetch(String controlName)	Retrieve the prefetch data for this set.
Object	suggestions(String query, String controlName)	Retrieve the suggestions for a particular query.

Method Details

suggestions

Object suggestions(String query,
 String controlName)

Retrieve the suggestions for a particular query. The second parameter is an optional control name for which the suggestions are requested.

Parameters:

query - usually the input of the user

controlName - name of the control for which the suggestions are requested

Returns:

suggestions result

prefetch

Object prefetch(String controlName)

Retrieve the prefetch data for this set. Prefetch data is the initial data that should be loaded and possibly shown as suggestions, without the user having entered a particular query string.

Parameters:

controlName - name of the control for which the suggestions are requested

Returns:

suggestions result

isPrefetchSupported

boolean isPrefetchSupported()

Returns:

true if data from this set can be pre-fetched

builder

static SimpleAutoSuggestDataSet.SimpleAutoSuggestDataSetBuilder builder()

Create a builder for a simple dataset. Using a

Returns:

builder for a simple auto-suggest dataset

forControl

static InitializingAutoSuggestDataSet.InitializingAutoSuggestDataSetBuilder forControl()