com.konakart.appif

Interface SuggestedSpellingOptionsIf

All Known Implementing Classes:

SuggestedSpellingOptions

public interface SuggestedSpellingOptionsIf

Used to configure the suggested spelling API call

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCatalogId() If the catalog id is set to a valid value and Solr is configured to create spelling suggestions for each catalog, then it is used to look up from a list of spelling suggestions items that are available for that catalog.
java.lang.String	getLanguageCode() If the language code is set to a valid value, this is used rather than the languageId which improves performance since the language doesn't have to be looked up.
int	getLanguageId() Id of the language object to be used.
int	getLimit() Maximum number of results to return.
java.lang.String	getSearchText() Search Text
void	setCatalogId(java.lang.String catalogId) If the catalog id is set to a valid value and Solr is configured to create spelling suggestions for each catalog, then it is used to look up from a list of spelling suggestions items that are available for that catalog.
void	setLanguageCode(java.lang.String languageCode) If the language code is set to a valid value, this is used rather than the languageId which improves performance since the language doesn't have to be looked up.
void	setLanguageId(int languageId) Id of the language object to be used.
void	setLimit(int limit) Maximum number of results to return.
void	setSearchText(java.lang.String searchText) Search Text

Method Detail

getLimit

int getLimit()

Maximum number of results to return. The default value is used when set to a negative number.

Returns:

the limit

setLimit

void setLimit(int limit)

Maximum number of results to return. The default value is used when set to a negative number.

Parameters:

limit - the limit to set

getSearchText

java.lang.String getSearchText()

Search Text

Returns:

the searchText

setSearchText

void setSearchText(java.lang.String searchText)

Search Text

Parameters:

searchText - the searchText to set

getLanguageCode

java.lang.String getLanguageCode()

If the language code is set to a valid value, this is used rather than the languageId which improves performance since the language doesn't have to be looked up.

Returns:

the languageCode

setLanguageCode

void setLanguageCode(java.lang.String languageCode)

If the language code is set to a valid value, this is used rather than the languageId which improves performance since the language doesn't have to be looked up.

Parameters:

languageCode - the languageCode to set

getLanguageId

int getLanguageId()

Id of the language object to be used.

Returns:

the languageId

setLanguageId

void setLanguageId(int languageId)

Id of the language object to be used.

Parameters:

languageId - the languageId to set

getCatalogId

java.lang.String getCatalogId()

If the catalog id is set to a valid value and Solr is configured to create spelling suggestions for each catalog, then it is used to look up from a list of spelling suggestions items that are available for that catalog. e.g. A catalog may contain only a subset of products.

Returns:

the catalogId

setCatalogId

void setCatalogId(java.lang.String catalogId)

If the catalog id is set to a valid value and Solr is configured to create spelling suggestions for each catalog, then it is used to look up from a list of spelling suggestions items that are available for that catalog. e.g. A catalog may contain only a subset of products.

Parameters:

catalogId - the catalogId to set