com.konakart.app

Class SuggestedSearchOptions

java.lang.Object

com.konakart.app.SuggestedSearchOptions

All Implemented Interfaces:

SuggestedSearchOptionsIf

public class SuggestedSearchOptions
extends java.lang.Object
implements SuggestedSearchOptionsIf

Used to configure the suggested search API call

Constructor Summary

Constructors

Constructor and Description
SuggestedSearchOptions() 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 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.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SuggestedSearchOptions

public SuggestedSearchOptions()

Constructor

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

Returns a string containing the attributes of the object.

getLimit

public int getLimit()

Description copied from interface: SuggestedSearchOptionsIf

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

Specified by:

getLimit in interface SuggestedSearchOptionsIf

Returns:

the limit

setLimit

public void setLimit(int limit)

Description copied from interface: SuggestedSearchOptionsIf

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

Specified by:

setLimit in interface SuggestedSearchOptionsIf

Parameters:

limit - the limit to set

getStartTag

public java.lang.String getStartTag()

Description copied from interface: SuggestedSearchOptionsIf

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

Specified by:

getStartTag in interface SuggestedSearchOptionsIf

Returns:

the startTag

setStartTag

public void setStartTag(java.lang.String startTag)

Description copied from interface: SuggestedSearchOptionsIf

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

Specified by:

setStartTag in interface SuggestedSearchOptionsIf

Parameters:

startTag - the startTag to set

getEndTag

public java.lang.String getEndTag()

Description copied from interface: SuggestedSearchOptionsIf

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

Specified by:

getEndTag in interface SuggestedSearchOptionsIf

Returns:

the endTag

setEndTag

public void setEndTag(java.lang.String endTag)

Description copied from interface: SuggestedSearchOptionsIf

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

Specified by:

setEndTag in interface SuggestedSearchOptionsIf

Parameters:

endTag - the endTag to set

getLanguageId

public int getLanguageId()

Description copied from interface: SuggestedSearchOptionsIf

Id of the language object to be used.

Specified by:

getLanguageId in interface SuggestedSearchOptionsIf

Returns:

the languageId

setLanguageId

public void setLanguageId(int languageId)

Description copied from interface: SuggestedSearchOptionsIf

Id of the language object to be used.

Specified by:

setLanguageId in interface SuggestedSearchOptionsIf

Parameters:

languageId - the languageId to set

getLanguageCode

public java.lang.String getLanguageCode()

Description copied from interface: SuggestedSearchOptionsIf

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 SuggestedSearchOptionsIf

Returns:

the languageCode

setLanguageCode

public void setLanguageCode(java.lang.String languageCode)

Description copied from interface: SuggestedSearchOptionsIf

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 SuggestedSearchOptionsIf

Parameters:

languageCode - the languageCode to set

getSearchText

public java.lang.String getSearchText()

Description copied from interface: SuggestedSearchOptionsIf

Search Text

Specified by:

getSearchText in interface SuggestedSearchOptionsIf

Returns:

the searchText

setSearchText

public void setSearchText(java.lang.String searchText)

Description copied from interface: SuggestedSearchOptionsIf

Search Text

Specified by:

setSearchText in interface SuggestedSearchOptionsIf

Parameters:

searchText - the searchText to set

isReturnRichText

public boolean isReturnRichText()

Description copied from interface: SuggestedSearchOptionsIf

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.

Specified by:

isReturnRichText in interface SuggestedSearchOptionsIf

Returns:

the returnRichText

setReturnRichText

public void setReturnRichText(boolean returnRichText)

Description copied from interface: SuggestedSearchOptionsIf

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.

Specified by:

setReturnRichText in interface SuggestedSearchOptionsIf

Parameters:

returnRichText - the returnRichText to set

isReturnRawText

public boolean isReturnRawText()

Description copied from interface: SuggestedSearchOptionsIf

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

Specified by:

isReturnRawText in interface SuggestedSearchOptionsIf

Returns:

the returnRawText

setReturnRawText

public void setReturnRawText(boolean returnRawText)

Description copied from interface: SuggestedSearchOptionsIf

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

Specified by:

setReturnRawText in interface SuggestedSearchOptionsIf

Parameters:

returnRawText - the returnRawText to set

getCatalogId

public java.lang.String getCatalogId()

Description copied from interface: SuggestedSearchOptionsIf

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.

Specified by:

getCatalogId in interface SuggestedSearchOptionsIf

Returns:

the catalogId

setCatalogId

public void setCatalogId(java.lang.String catalogId)

Description copied from interface: SuggestedSearchOptionsIf

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.

Specified by:

setCatalogId in interface SuggestedSearchOptionsIf

Parameters:

catalogId - the catalogId to set

getTopLevelCategoryId

public int getTopLevelCategoryId()

Description copied from interface: SuggestedSearchOptionsIf

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.

Specified by:

getTopLevelCategoryId in interface SuggestedSearchOptionsIf

Returns:

the topLevelCategoryId

setTopLevelCategoryId

public void setTopLevelCategoryId(int topLevelCategoryId)

Description copied from interface: SuggestedSearchOptionsIf

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.

Specified by:

setTopLevelCategoryId in interface SuggestedSearchOptionsIf

Parameters:

topLevelCategoryId - the topLevelCategoryId to set