com.konakart.appif

Interface SuggestedSearchOptionsIf

All Known Implementing Classes:

SuggestedSearchOptions

public interface SuggestedSearchOptionsIf

Used to configure the suggested search 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 a suggested search list for each catalog, then it is used to look up from a list of suggested search items that are available for that catalog.
java.lang.String	getEndTag() HTML end tag for search string.
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
java.lang.String	getStartTag() HTML start tag for search string.
int	getTopLevelCategoryId() When set to a number greater than 0, it limits results to products within the category tree where the top level category is defined by this id.
boolean	isReturnRawText() When set to true, the raw text attribute of the suggested search item contains a value, otherwise it is null.
boolean	isReturnRichText() When set to true, the results are returned with formatting to highlight the search string within the results.
void	setCatalogId(java.lang.String catalogId) If the catalog id is set to a valid value and Solr is configured to create a suggested search list for each catalog, then it is used to look up from a list of suggested search items that are available for that catalog.
void	setEndTag(java.lang.String endTag) HTML end tag for search string.
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	setReturnRawText(boolean returnRawText) When set to true, the raw text attribute of the suggested search item contains a value, otherwise it is null.
void	setReturnRichText(boolean returnRichText) When set to true, the results are returned with formatting to highlight the search string within the results.
void	setSearchText(java.lang.String searchText) Search Text
void	setStartTag(java.lang.String startTag) HTML start tag for search string.
void	setTopLevelCategoryId(int topLevelCategoryId) When set to a number greater than 0, it limits results to products within the category tree where the top level category is defined by this id.

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

isReturnRichText

boolean isReturnRichText()

When set to true, the results are returned with formatting to highlight the search string within the results. When false, the rich text attribute of the suggested search item is null. Default value is true.

Returns:

the returnRichText

setReturnRichText

void setReturnRichText(boolean returnRichText)

When set to true, the results are returned with formatting to highlight the search string within the results. When false, the rich text attribute of the suggested search item is null. Default value is true.

Parameters:

returnRichText - the returnRichText to set

isReturnRawText

boolean isReturnRawText()

When set to true, the raw text attribute of the suggested search item contains a value, otherwise it is null. Default value is false.

Returns:

the returnRawText

setReturnRawText

void setReturnRawText(boolean returnRawText)

When set to true, the raw text attribute of the suggested search item contains a value, otherwise it is null. Default value is false.

Parameters:

returnRawText - the returnRawText to set

getStartTag

java.lang.String getStartTag()

HTML start tag for search string. Default value is <b>.

Returns:

the startTag

setStartTag

void setStartTag(java.lang.String startTag)

HTML start tag for search string. Default value is <b>.

Parameters:

startTag - the startTag to set

getEndTag

java.lang.String getEndTag()

HTML end tag for search string. Default value is </b>.

Returns:

the endTag

setEndTag

void setEndTag(java.lang.String endTag)

HTML end tag for search string. Default value is </b>.

Parameters:

endTag - the endTag 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 a suggested search list for each catalog, then it is used to look up from a list of suggested search 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 a suggested search list for each catalog, then it is used to look up from a list of suggested search items that are available for that catalog. e.g. A catalog may contain only a subset of products.

Parameters:

catalogId - the catalogId to set

getTopLevelCategoryId

int getTopLevelCategoryId()

When set to a number greater than 0, it limits results to products within the category tree where the top level category is defined by this id. The top level category does not have a parent.

Returns:

the topLevelCategoryId

setTopLevelCategoryId

void setTopLevelCategoryId(int topLevelCategoryId)

When set to a number greater than 0, it limits results to products within the category tree where the top level category is defined by this id. The top level category does not have a parent.

Parameters:

topLevelCategoryId - the topLevelCategoryId to set