com.ibm.commerce.search.beans

Class SearchBaseDataBean

java.lang.Object

com.ibm.commerce.beans.InputDataBeanImpl

com.ibm.commerce.beans.SmartDataBeanImpl

com.ibm.commerce.search.beans.SearchBaseDataBean

All Implemented Interfaces:

DataBean, InputDataBean, SmartDataBean, SearchConstants, java.io.Serializable

Direct Known Subclasses:

CatalogSearchListDataBean, CategorySearchListDataBean, CatEntrySearchListDataBean

public abstract class SearchBaseDataBean
extends SmartDataBeanImpl
implements SearchConstants

This abstract class is the super class of other search databeans. Search databeans allow users to retrieve information from the database based on search criteria.
Specific information can be retrieved from the database using the appropriate search data bean classes, which extend this super class.

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.ibm.commerce.search.beans.SearchConstants

ALL, ALL_CATALOG, ALL_CATEGORIES, ALLWORDS, ANYWORDS, ATTRVALUE_FLOATVALUE, ATTRVALUE_INTEGERVALUE, ATTRVALUE_STRINGVALUE, BOTH, CASE_SENSITIVE, CATGPENREL_BOTH_SCHEMA_TYPE, CATGPENREL_PRODUCT_SCHEMA_TYPE, DISTINCT_RESULT, EXACTPHRASE, ITEM, LISTPRICE_ON, MASTER_CATALOG, OPERATOR_EQUAL, OPERATOR_GREATER, OPERATOR_GREATER_EQUAL, OPERATOR_IN, OPERATOR_LEFT_LIKE, OPERATOR_LESS, OPERATOR_LESS_EQUAL, OPERATOR_LIKE, OPERATOR_NOT_EQUAL, OPERATOR_NOT_LIKE, OPERATOR_RIGHT_LIKE, PRODUCT, SEARCH_IN_CATEGORYNAME, SEARCH_IN_CATEGORYNAME_AND_DESCRIPTIONS, SEARCH_IN_CATEGORYNAME_AND_SHORT_DESCRIPTION, SEARCH_IN_KEYWORD, SEARCH_IN_PRODUCTNAME, SEARCH_IN_PRODUCTNAME_AND_DESCRIPTIONS, SEARCH_IN_PRODUCTNAME_AND_SHORT_DESCRIPTION

Fields inherited from interface com.ibm.commerce.beans.DataBean

emptyString

Constructor Summary

Constructors

Constructor and Description
SearchBaseDataBean() SearchDataBean constructor comment.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBeginIndex() Returns beginIndex of type String
int	getCurrentPageNumber() Returns the current page number in the result set (based on page size -- if page size is zero or null, this function returns 1)
int	getEndIndex() Returns the end index for the result set on the page.
boolean	getExceededPageSize() This method indicates whether the pageSize set has exceeded maxPageSize limits of ProductSearchThreshold or not.
java.util.Locale	getLocale() gets the locale used in the data bean.
java.lang.String	getPageSize() Return pageSize of type String
java.lang.String	getResultCount() Returns resultCount.
int	getResultSetSize() Gets the size of the result set list
int	getTotalNumberOfResultSetPages() Returns the total number of pages in the result set (based on page size -- if page size is zero or null, this function returns 1)
boolean	isNextPageExists() Determines whether a next page of data exists
boolean	isPreviousPageExists() Determines whether a previous page of data exists
boolean	isResultSetEmpty() Determines whether the result set is empty
abstract void	populate() Populate the data bean.
void	setAcceleratorFlag(boolean newAcceleratorFlag) To set acceleratorFlag.
void	setBeginIndex(java.lang.String newBeginIndex) The beginIndex identifies the first element result of any page from total number of elements in result set.
void	setExceededPageSize(boolean newExceededPageSize) To set exceededPageSize.
void	setLocale(java.util.Locale locale) sets the locale used in the data bean.
void	setPageSize(java.lang.String newPageSize) To set pageSize defines the number elements in each page
void	setResultCount(java.lang.String newResultCount) The resultCount is the total number of elements in result set

Methods inherited from class com.ibm.commerce.beans.SmartDataBeanImpl

fulfills, getCommandContext, getHttpRequest, getHttpResponse, getResources, getViewCommandContext, setCommandContext, setHttpRequest, setHttpResponse, setViewCommandContext

Methods inherited from class com.ibm.commerce.beans.InputDataBeanImpl

getRequestProperties, setRequestProperties

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.ibm.commerce.beans.InputDataBean

getRequestProperties, setRequestProperties

Constructor Detail

SearchBaseDataBean

public SearchBaseDataBean()

SearchDataBean constructor comment.

Method Detail

getBeginIndex

public java.lang.String getBeginIndex()

Returns beginIndex of type String

Returns:

The starting index for a page

getPageSize

public java.lang.String getPageSize()

Return pageSize of type String

Returns:

The number of search result records to be displayed in a page.

getResultCount

public java.lang.String getResultCount()

Returns resultCount. resultCount (String) : This variable will contain total number of results returned for a search.

Returns:

The number of rows retrieved for this search criteria.

getExceededPageSize

public boolean getExceededPageSize()

This method indicates whether the pageSize set has exceeded maxPageSize limits of ProductSearchThreshold or not.

Returns:

true if limits exceeded false otherwise.

populate

public abstract void populate()
                       throws java.lang.Exception

Populate the data bean.

Specified by:

populate in interface SmartDataBean

Overrides:

populate in class SmartDataBeanImpl

Throws:

java.lang.Exception - This method should never be thrown because there is no data retrieved to populate the data bean.

setBeginIndex

public void setBeginIndex(java.lang.String newBeginIndex)

The beginIndex identifies the first element result of any page from total number of elements in result set.

Parameters:

newBeginIndex - int. The first element result of any page from total number of elements in result set.

setPageSize

public void setPageSize(java.lang.String newPageSize)

To set pageSize defines the number elements in each page

Parameters:

newPageSize - int. The number of elements in each page.

setAcceleratorFlag

public void setAcceleratorFlag(boolean newAcceleratorFlag)

To set acceleratorFlag.

Parameters:

newAcceleratorFlag - boolean. Used for IBM Internal Use Only

setResultCount

public void setResultCount(java.lang.String newResultCount)

The resultCount is the total number of elements in result set

Parameters:

newResultCount - java.lang.String. The total number of elements in the result set.

setExceededPageSize

public void setExceededPageSize(boolean newExceededPageSize)

To set exceededPageSize.

Parameters:

newExceededPageSize - boolean. The exceeded flag.

getResultSetSize

public int getResultSetSize()

Gets the size of the result set list

Returns:

the size

isResultSetEmpty

public boolean isResultSetEmpty()

Determines whether the result set is empty

Returns:

true if the result set is empty

isPreviousPageExists

public boolean isPreviousPageExists()

Determines whether a previous page of data exists

Returns:

true if there is a previous page, false otherwise

isNextPageExists

public boolean isNextPageExists()

Determines whether a next page of data exists

Returns:

true if there is a next page, false otherwise

getEndIndex

public int getEndIndex()

Returns the end index for the result set on the page. The end index identifies the last element result of any page from total number of elements in result set.

Returns:

the end index

getTotalNumberOfResultSetPages

public int getTotalNumberOfResultSetPages()

Returns the total number of pages in the result set (based on page size -- if page size is zero or null, this function returns 1)

Returns:

the total number of pages in the result set

getCurrentPageNumber

public int getCurrentPageNumber()

Returns the current page number in the result set (based on page size -- if page size is zero or null, this function returns 1)

Returns:

the current page number in the result set

getLocale

public java.util.Locale getLocale()

gets the locale used in the data bean.

Returns:

the locale used in the data bean.

setLocale

public void setLocale(java.util.Locale locale)

sets the locale used in the data bean.

Parameters:

locale - the locale.