cz.ues.platform.uwt.searchbox

Interface UESSuggestService

@UESComponent
public interface UESSuggestService

The service for accessing suggest items and its history.

Since:

UES7-08

Method Summary

Methods

Modifier and Type	Method and Description
SuggestHistoryEntry[]	getHistoryEntryList(SuggestHistoryKey aKey) Returns history entries of a suggest.
SuggestItem[]	getItemList(java.lang.String aProvider, SuggestContext aContext) Returns a list of suggest items provided by aProvider component.
void	putHistoryValue(SuggestHistoryKey aKey, java.lang.String aValue) Stores value aValue to the suggest history with key aKey.

Method Detail

getItemList

SuggestItem[] getItemList(java.lang.String aProvider,
SuggestContext aContext)

Returns a list of suggest items provided by aProvider component.

Parameters:

aProvider - The name of the provider component to use.

aContext - The suggest context which can contain additonal attributes if required by the provider.

Returns:

The list of suggest items.

Since:

UES7-08

putHistoryValue

void putHistoryValue(SuggestHistoryKey aKey,
java.lang.String aValue)

Stores value aValue to the suggest history with key aKey.

Parameters:

aKey - The history key.

aValue - The value to store.

Since:

UES7-08

getHistoryEntryList

SuggestHistoryEntry[] getHistoryEntryList(SuggestHistoryKey aKey)

Returns history entries of a suggest.

Parameters:

aKey - The history key.

Returns:

A non-null array of history entries.

Since:

UES7-08