Package org.apache.ofbiz.product.product

Class ProductSearchSession

java.lang.Object

org.apache.ofbiz.product.product.ProductSearchSession

public class ProductSearchSession
extends java.lang.Object

Utility class with methods to prepare and perform ProductSearch operations in the content of an HttpSession

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ProductSearchSession.ProductSearchOptions

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	module

Constructor Summary

Constructors

Constructor	Description
ProductSearchSession()

Method Summary

Modifier and Type	Method	Description
static java.lang.String	checkDoKeywordOverride(HttpServletRequest request, HttpServletResponse response)	A ControlServlet event method used to check to see if there is an override for any of the current keywords in the search
static void	checkSaveSearchOptionsHistory(HttpSession session)
static java.lang.String	clearSearchOptionsHistoryList(HttpServletRequest request, HttpServletResponse response)
static void	clearSearchOptionsHistoryList(HttpSession session)
static int	getCategoryCostraintIndex(HttpSession session)
static long	getCountForListPriceRange(java.math.BigDecimal priceLow, java.math.BigDecimal priceHigh, HttpSession session, Delegator delegator)	This method returns count of products within a given price range, the constraint being applied on current ProductSearchConstraint list in session.
static long	getCountForProductCategory(java.lang.String productCategoryId, HttpSession session, Delegator delegator)	This method returns count of products in a given category (including all sub categories), the constraint being applied on current ProductSearchConstraint list in session.
static ProductSearchSession.ProductSearchOptions	getProductSearchOptions(HttpSession session)
static java.util.Map<java.lang.String,java.lang.Object>	getProductSearchResult(HttpServletRequest request, Delegator delegator, java.lang.String prodCatalogId)
static java.util.List<ProductSearchSession.ProductSearchOptions>	getSearchOptionsHistoryList(HttpSession session)
static java.util.List<java.util.Map<java.lang.String,java.lang.String>>	listCountByFeatureForType(java.lang.String productFeatureTypeId, HttpSession session, Delegator delegator)	This method returns a list of productId counts grouped by productFeatureId's of input productFeatureTypeId, the constraint being applied on current ProductSearchConstraint list in session.
static java.lang.String	makeSearchParametersString(HttpSession session)
static java.lang.String	makeSearchParametersString(ProductSearchSession.ProductSearchOptions productSearchOptions)
static void	processSearchParameters(java.util.Map<java.lang.String,java.lang.Object> parameters, HttpServletRequest request)
static void	searchAddConstraint(ProductSearch.ProductSearchConstraint productSearchConstraint, HttpSession session)
static void	searchAddFeatureIdConstraints(java.util.Collection<java.lang.String> featureIds, java.lang.Boolean exclude, HttpServletRequest request)
static void	searchClear(HttpSession session)
static java.util.ArrayList<java.lang.String>	searchDo(HttpSession session, Delegator delegator, java.lang.String prodCatalogId)
static java.util.List<java.lang.String>	searchGetConstraintStrings(boolean detailed, HttpSession session, Delegator delegator)
static java.lang.String	searchGetSortOrderString(boolean detailed, HttpServletRequest request)
static void	searchRemoveConstraint(int index, HttpSession session)
static void	searchSetSortOrder(ProductSearch.ResultSortOrder resultSortOrder, HttpSession session)
static void	setCurrentSearchFromHistory(int index, boolean removeOld, HttpSession session)
static java.lang.String	setCurrentSearchFromHistory(HttpServletRequest request, HttpServletResponse response)

Methods inherited from class java.lang.Object

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

Field Detail

module

public static final java.lang.String module

Constructor Detail

ProductSearchSession

public ProductSearchSession()

Method Detail

getProductSearchOptions

public static ProductSearchSession.ProductSearchOptions getProductSearchOptions(HttpSession session)

checkSaveSearchOptionsHistory

public static void checkSaveSearchOptionsHistory(HttpSession session)

getSearchOptionsHistoryList

public static java.util.List<ProductSearchSession.ProductSearchOptions> getSearchOptionsHistoryList(HttpSession session)

clearSearchOptionsHistoryList

public static void clearSearchOptionsHistoryList(HttpSession session)

setCurrentSearchFromHistory

public static void setCurrentSearchFromHistory(int index,
                                               boolean removeOld,
                                               HttpSession session)

clearSearchOptionsHistoryList

public static java.lang.String clearSearchOptionsHistoryList(HttpServletRequest request,
                                                             HttpServletResponse response)

setCurrentSearchFromHistory

public static java.lang.String setCurrentSearchFromHistory(HttpServletRequest request,
                                                           HttpServletResponse response)

checkDoKeywordOverride

public static final java.lang.String checkDoKeywordOverride(HttpServletRequest request,
                                                            HttpServletResponse response)

A ControlServlet event method used to check to see if there is an override for any of the current keywords in the search

searchDo

public static java.util.ArrayList<java.lang.String> searchDo(HttpSession session,
                                                             Delegator delegator,
                                                             java.lang.String prodCatalogId)

searchClear

public static void searchClear(HttpSession session)

searchGetConstraintStrings

public static java.util.List<java.lang.String> searchGetConstraintStrings(boolean detailed,
                                                                          HttpSession session,
                                                                          Delegator delegator)

searchGetSortOrderString

public static java.lang.String searchGetSortOrderString(boolean detailed,
                                                        HttpServletRequest request)

searchSetSortOrder

public static void searchSetSortOrder(ProductSearch.ResultSortOrder resultSortOrder,
                                      HttpSession session)

searchAddFeatureIdConstraints

public static void searchAddFeatureIdConstraints(java.util.Collection<java.lang.String> featureIds,
                                                 java.lang.Boolean exclude,
                                                 HttpServletRequest request)

searchAddConstraint

public static void searchAddConstraint(ProductSearch.ProductSearchConstraint productSearchConstraint,
                                       HttpSession session)

searchRemoveConstraint

public static void searchRemoveConstraint(int index,
                                          HttpSession session)

processSearchParameters

public static void processSearchParameters(java.util.Map<java.lang.String,java.lang.Object> parameters,
                                           HttpServletRequest request)

getProductSearchResult

public static java.util.Map<java.lang.String,java.lang.Object> getProductSearchResult(HttpServletRequest request,
                                                                                            Delegator delegator,
                                                                                            java.lang.String prodCatalogId)

makeSearchParametersString

public static java.lang.String makeSearchParametersString(HttpSession session)

makeSearchParametersString

public static java.lang.String makeSearchParametersString(ProductSearchSession.ProductSearchOptions productSearchOptions)

listCountByFeatureForType

public static java.util.List<java.util.Map<java.lang.String,java.lang.String>> listCountByFeatureForType(java.lang.String productFeatureTypeId,
                                                                                                               HttpSession session,
                                                                                                               Delegator delegator)

This method returns a list of productId counts grouped by productFeatureId's of input productFeatureTypeId, the constraint being applied on current ProductSearchConstraint list in session.

Parameters:

productFeatureTypeId - The productFeatureTypeId, productFeatureId's of which should be considered.

session - Current session.

delegator - The delegator object.

Returns:

List of Maps containing productFeatureId, productFeatureTypeId, description, featureCount.

getCategoryCostraintIndex

public static int getCategoryCostraintIndex(HttpSession session)

getCountForListPriceRange

public static long getCountForListPriceRange(java.math.BigDecimal priceLow,
                                             java.math.BigDecimal priceHigh,
                                             HttpSession session,
                                             Delegator delegator)

This method returns count of products within a given price range, the constraint being applied on current ProductSearchConstraint list in session.

Parameters:

priceLow - The low price.

priceHigh - The high price.

session - Current session.

delegator - The delegator object.

Returns:

The long value of count of products.

getCountForProductCategory

public static long getCountForProductCategory(java.lang.String productCategoryId,
                                              HttpSession session,
                                              Delegator delegator)

This method returns count of products in a given category (including all sub categories), the constraint being applied on current ProductSearchConstraint list in session.

Parameters:

productCategoryId - productCategoryId for which the count should be returned.

session - Current session.

delegator - The delegator object.

Returns:

The long value of count of products.