Package de.cxp.ocs.smartsuggest.spi

Interface SuggestConfigProvider

All Known Implementing Classes:

CompoundSuggestConfigProvider, DefaultSuggestConfigProvider, SuggestServiceProperties

public interface SuggestConfigProvider

Method Summary

Modifier and Type	Method	Description
SuggestConfig	getConfig(@NonNull String indexName, SuggestConfig defaultSuggestConfig)	Retrieve config for a given index.
default int	getPriority()	Return priority when this config provider should be asked for the configuration.

Method Details

getConfig

SuggestConfig getConfig(@NonNull
 @NonNull String indexName,
 SuggestConfig defaultSuggestConfig)

Retrieve config for a given index. In case only some index specific values should be set, the default suggest config can be used since it may contain global settings (if not null).

Parameters:

indexName -

defaultSuggestConfig - copy of the suggest config that was set as default for the whole service. It can be modified and returned or a different config object can be returned. Returning null is considered equivalent to returning that default config.

Returns:

getPriority

default int getPriority()

Return priority when this config provider should be asked for the configuration. Providers with a low priority value (e.g. 1) will be asked first and providers with a higher value will be called later and can overwrite previously set values.

Returns:

priority value, defaults to 100