com.konakart.rmi.app
Class S_SuggestedSearchOptions

java.lang.Object
  com.konakart.rmi.app.S_SuggestedSearchOptions

All Implemented Interfaces:

java.io.Serializable

public class S_SuggestedSearchOptions
extends java.lang.Object
implements java.io.Serializable

Used to configure the suggested search API call

See Also:

Serialized Form

Constructor Summary

S_SuggestedSearchOptions()

Method Summary

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.
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	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.

Methods inherited from class java.lang.Object

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

Constructor Detail

S_SuggestedSearchOptions

public S_SuggestedSearchOptions()

Method Detail

getLimit

public int getLimit()

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

Returns:

the limit

setLimit

public 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

public java.lang.String getSearchText()

Search Text

Returns:

the searchText

setSearchText

public void setSearchText(java.lang.String _searchText)

Search Text

Parameters:

_searchText - the searchText to set

isReturnRichText

public 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

public 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

public 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

public 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

public java.lang.String getStartTag()

HTML start tag for search string. Default value is .

Returns:

the startTag

setStartTag

public void setStartTag(java.lang.String _startTag)

HTML start tag for search string. Default value is .

Parameters:

_startTag - the startTag to set

getEndTag

public java.lang.String getEndTag()

HTML end tag for search string. Default value is .

Returns:

the endTag

setEndTag

public void setEndTag(java.lang.String _endTag)

HTML end tag for search string. Default value is .

Parameters:

_endTag - the endTag to set

getLanguageCode

public 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

public 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

public int getLanguageId()

Id of the language object to be used.

Returns:

the languageId

setLanguageId

public void setLanguageId(int _languageId)

Id of the language object to be used.

Parameters:

_languageId - the languageId to set