com.ibm.commerce.search.beans

Class SearchBaseDataBean

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