com.konakart.app

Class SuggestedSpellingOptions

java.lang.Object

com.konakart.app.SuggestedSpellingOptions

All Implemented Interfaces:

SuggestedSpellingOptionsIf

public class SuggestedSpellingOptions
extends java.lang.Object
implements SuggestedSpellingOptionsIf

Used to configure the suggested spelling API call

Constructor Summary

Constructors

Constructor and Description
SuggestedSpellingOptions() Constructor

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SuggestedSpellingOptions

public SuggestedSpellingOptions()

Constructor

Method Detail

getLimit

public int getLimit()

Description copied from interface: SuggestedSpellingOptionsIf

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

Specified by:

getLimit in interface SuggestedSpellingOptionsIf

Returns:

the limit

setLimit

public void setLimit(int limit)

Description copied from interface: SuggestedSpellingOptionsIf

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

Specified by:

setLimit in interface SuggestedSpellingOptionsIf

Parameters:

limit - the limit to set

getLanguageId

public int getLanguageId()

Description copied from interface: SuggestedSpellingOptionsIf

Id of the language object to be used.

Specified by:

getLanguageId in interface SuggestedSpellingOptionsIf

Returns:

the languageId

setLanguageId

public void setLanguageId(int languageId)

Description copied from interface: SuggestedSpellingOptionsIf

Id of the language object to be used.

Specified by:

setLanguageId in interface SuggestedSpellingOptionsIf

Parameters:

languageId - the languageId to set

getLanguageCode

public java.lang.String getLanguageCode()

Description copied from interface: SuggestedSpellingOptionsIf

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.

Specified by:

getLanguageCode in interface SuggestedSpellingOptionsIf

Returns:

the languageCode

setLanguageCode

public void setLanguageCode(java.lang.String languageCode)

Description copied from interface: SuggestedSpellingOptionsIf

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.

Specified by:

setLanguageCode in interface SuggestedSpellingOptionsIf

Parameters:

languageCode - the languageCode to set

getSearchText

public java.lang.String getSearchText()

Description copied from interface: SuggestedSpellingOptionsIf

Search Text

Specified by:

getSearchText in interface SuggestedSpellingOptionsIf

Returns:

the searchText

setSearchText

public void setSearchText(java.lang.String searchText)

Description copied from interface: SuggestedSpellingOptionsIf

Search Text

Specified by:

setSearchText in interface SuggestedSpellingOptionsIf

Parameters:

searchText - the searchText to set

getCatalogId

public java.lang.String getCatalogId()

Description copied from interface: SuggestedSpellingOptionsIf

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.

Specified by:

getCatalogId in interface SuggestedSpellingOptionsIf

Returns:

the catalogId

setCatalogId

public void setCatalogId(java.lang.String catalogId)

Description copied from interface: SuggestedSpellingOptionsIf

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.

Specified by:

setCatalogId in interface SuggestedSpellingOptionsIf

Parameters:

catalogId - the catalogId to set