com.ibm.commerce.search.beans
Class CatEntrySearchListDataBean

com.ibm.commerce.search.beans.CatEntrySearchListDataBean
All Implemented Interfaces:
SearchConstants

public class CatEntrySearchListDataBean
implements SearchConstants

This bean is used to retrieve product/item information from catalog based on input search criteria. The search criteria may be input using a JSP. List of variables that may be input using JSP are as follows.

  1. beginIndex (String): This variable is used for paging the result set. The value must be the index of the first result row in a page.
  2. catGroupId (String): The value of this variable is used in search on a catagory id (table coulmns searched: Catgpenrel.Catgroupid).
  3. categoryTerm (String): The value of this variable is used in search on category name and/or descriptions (table columns searched: Catgrpdesc.name, Catgrpdesc.Shortdescription, Catgrpdesc.Longdescription).
  4. categoryTermCaseSensitive (String): A user can choose case sensitive or case insensitive search. The value in this variable is used to identify if a search is case sensitive or not. The value must be either 'yes'(case sensitive search) or 'no'(case insensitive search).
  5. categoryTermOperator (String): A user can choose either 'like' or 'equal' as search operators. The value in this variable is used to store a user's choice. The value must be either 'LIKE'(for like operator) or 'EQUAL'(for equal operator).
  6. categoryTermScope (Integer) : A user can restrict the scope (of 'search term'/ 'filter term' search) to name; name and short description; or name, short description and long description. The value in this variable is used to store a user's choice. The value must be 1 (for name and short description), or 2 (for name only), or 3 (for name, short description and long description).
  7. categoryType (String) : A user can specify three types of search criteria All, Any, Exact Phrase. The value in this variable is used to store a user's search criteria. The value must be 'ALL'(for All search criteria), 'ANY'(for Any search criteria) and 'EXACT'(for Exact phrase criteria).
  8. catgrpSchemaType (String) : The WCS schema is flexible and data can be populated in multiple ways. For example CATGPENREL table can be populated with products or both products and items. The queries generated by the bean at runtime depends on type of data in CATGPENREL table. The value in this variable is used to store the data population type. The value must be either 1 (the CATGPENREL has only products) or 2 (the CATGPENREL has both items and products).
  9. currency (String) : The value of this variable is used in search on a currency (table columns searched: Offerprice.Currency).
  10. currencyCaseSensitive (String) : A user can choose case sensitive or case insensitive search. The value in this variable is used to identify if a search is case sensitive or not. The value must be either 'yes'(case sensitive search) or 'no'(case insensitive search).
  11. currencyOperator (String) : A user can choose either 'like' or 'equal' as search operators. The value in this variable is used to store a user's choice. The value must be either 'LIKE'(for like operator) or 'EQUAL'(for equal operator).
  12. filterTerm (String) : The value in this variable is used to filter a search on a specified value (table columns searched: Catentdesc.name, Catentdesc.Shortdescription, Catentdesc.Longdescription).
  13. filterTermCaseSensitive (String) : A user can choose case sensitive or case insensitive search. The value in this variable is used to identify if a search is case sensitive or not. The value must be either 'yes'(case sensitive search) or 'no'(case insensitive search).
  14. filterTermOperator (String) : A user can choose either 'like' or 'equal' as search operators. The value in this variable is used to store a user's choice. The value must be either 'LIKE'(for like operator) or 'EQUAL'(for equal operator).
  15. filterType (String) : A user can specify three types of search criteria All, Any, Exact Phrase. The value in this variable is used to store a user's search criteria. The value must be 'ALL'(for All search criteria), 'ANY'(for Any search criteria) and 'EXACT'(for Exact phrase criteria).
  16. manufacturer (String) : The value of this variable is used in search on a manufacturer's name (table columns searched: Catentry.Mfname).
  17. manufacturerCaseSensitive (String) : A user can choose case sensitive or case insensitive search. The value in this variable is used to identify if a search is case sensitive or not. The value must be either 'yes'(case sensitive search) or 'no'(case insensitive search).
  18. manufacturerOperator (String) : A user can choose either 'like' or 'equal' as search operators. The value in this variable is used to store a user's choice. The value must be either 'LIKE'(for like operator) or 'EQUAL'(for equal operator).
  19. manufacturerPartNum (String) : The value of this variable is used in search on a manufacturer's part number (table columns searched: Catentry.Mfpartnumber).
  20. manufacturerPartNumCaseSensitive (String) : A user can choose case sensitive or case insensitive search. The value in this variable is used to identify if a search is case sensitive or not. The value must be either 'yes'(case sensitive search) or 'no'(case insensitive search).
  21. manufacturerPartNumOperator (String) : A user can choose either 'like' or 'equal' as search operators. The value in this variable is used to store a user's choice. The value must be either 'LIKE'(for like operator) or 'EQUAL'(for equal operator).
  22. maxPrice/minPrice (String) : The vlaues of these variables are used in search on price range (table columns searched: offerprice.currency, offerprice.price).
  23. pageSize (String) : The value of this variable specifies number of search result rows to be displayed per page.
  24. price (String) : The value of this variable is used in search on price (table columns searched: offerprice.currency, offerprice.price).
  25. priceOperator (String) : A user can choose one of the following operators as search operators: =, <, >, !=, <=, >=. The value in this variable is used to store a user's choice. The value must be any one of the following: 'EQUAL,' 'NOTEQUAL,' 'GREATER,' 'LESS,' 'GREATER_EQUAL,' 'LESS_EQUAL.'
  26. qtyAvailable (String) : The value of this variable is used in search on inventory of a product/item (view columns searched: Invstvw.Quantity_Available).
  27. qtyAvailableOperator (String) : A user can choose one of the following operators as search operators: =, <, >,!=, <=, >=. The value in this variable is used to store a user's choice. The value must be any one of the following: 'EQUAL,' 'NOTEQUAL,' 'GREATER,' 'LESS,' 'GREATER_EQUAL,' 'LESS_EQUAL.'
  28. qtyMeasure (String) : The value of this variable is used in search on quantity measure (view columns searched: Invstvw.Quantity_Measure)..
  29. qtyMeasureCaseSensitive (String) : A user can choose case sensitive or case insensitive search. The value in this variable is used to identify if a search is case sensitive or not. The value must be either 'yes'(case sensitive search) or 'no'(case insensitive search).
  30. qtyMeasureOperator (String) : A user can choose either 'like' or 'equal' as search operators. The value in this variable is used to store a user's choice. The value must be either 'LIKE'(for like operator) or 'EQUAL'(for equal operator).
  31. resultCount (String) : This variable will contain total number of results returned for a search.
  32. resultType (String) : Merchant can specify if they want to show Products or Items or both Products and Items in a search result. The value in this variable is used to store this value. The value must be 1 (Products only), 2 (Items only) or 3 (both products and items).
  33. searchTerm (String) : The value of this variable is used in search on a word (table columns searched: Catentdesc.name, Catentdesc.Shortdescription, Catentdesc.Longdescription).
  34. searchTermCaseSensitive (String) : A user can choose case sensitive or case insensitive search. The value in this variable is used to identify if a search is case sensitive or not. The value must be either 'yes'(case sensitive search) or 'no'(case insensitive search).
  35. searchTermOperator (String) : A user can choose either 'like' or 'equal' as search operators. The value in this variable is used to store a user's choice. The value must be either 'LIKE'(for like operator) or 'EQUAL'(for equal operator).
  36. searchTermScope (Integer) : A user can restrict the scope (of 'search term'/ 'filter term' search) to name; name and short description; or name, short description and long description; or keyword. The value in this variable is used to store a user's choice. The value must be 1 (for name and short description), or 2 (for name only), or 3 (for name, short description and long description) or 4 (for keyword).
  37. searchType (String) : A user can specify three types of search criteria All, Any, Exact Phrase. The value in this variable is used to store a user's search criteria. The value must be 'ALL'(for All search criteria), 'ANY'(for Any search criteria) and 'EXACT'(for Exact phrase criteria).
  38. sku (String) : The value of this variable is used in serach on SKU (table columns searched: Catentry.Sku).
  39. skuCaseSensitive (String) : A user can choose case sensitive or case insensitive search. The value in this variable is used to identify if a search is case sensitive or not. The value must be either 'yes'(case sensitive search) or 'no'(case insensitive search).
  40. skuOperator (String) : A user can choose either 'like' or 'equal' as search operators. The value in this variable is used to store a user's choice. The value must be either 'LIKE'(for like operator) or 'EQUAL'(for equal operator).


Field Summary
protected  com.ibm.commerce.search.beans.Cursor aCursor
           
protected  java.lang.String beginIndex
           
protected  java.lang.String categoryTerm
           
protected  java.lang.String categoryTermCaseSensitive
           
protected  java.lang.String categoryTermOperator
           
protected  java.lang.Integer categoryTermScope
           
protected  java.lang.String categoryType
           
protected  java.lang.String catGroupId
           
protected  java.lang.String catgrpSchemaType
           
protected  java.lang.String currency
           
protected  java.lang.String currencyCaseSensitive
           
protected  java.lang.String currencyOperator
           
protected  java.lang.String filterTerm
           
protected  java.lang.String filterTermCaseSensitive
           
protected  java.lang.String filterTermOperator
           
protected  java.lang.String filterType
           
protected  boolean isAllNull
           
protected  java.lang.String isListPriceOn
           
protected  java.lang.String manufacturer
           
protected  java.lang.String manufacturerCaseSensitive
           
protected  java.lang.String manufacturerOperator
           
protected  java.lang.String manufacturerPartNum
           
protected  java.lang.String manufacturerPartNumCaseSensitive
           
protected  java.lang.String manufacturerPartNumOperator
           
protected  java.lang.String maxPrice
           
protected  java.lang.String minPrice
           
protected  java.lang.String pageSize
           
protected  java.lang.String price
           
protected  java.lang.String priceOperator
           
protected  RuleQuery q
           
protected  java.lang.String qtyAvailable
           
protected  java.lang.String qtyAvailableOperator
           
protected  java.lang.String qtyMeasure
           
protected  java.lang.String qtyMeasureCaseSensitive
           
protected  java.lang.String qtyMeasureOperator
           
protected  java.lang.String RASchemaType
           
protected  java.lang.String resultCount
           
protected  CatalogEntryDataBean[] resultList
           
protected  java.lang.String resultType
           
protected  java.lang.String searchTerm
           
protected  java.lang.String searchTermCaseSensitive
           
protected  java.lang.String searchTermOperator
           
protected  java.lang.Integer searchTermScope
           
protected  java.lang.String searchType
           
protected  java.lang.String sku
           
protected  java.lang.String skuCaseSensitive
           
protected  java.lang.String skuOperator
           
 
Fields inherited from interface com.ibm.commerce.search.beans.SearchConstants
ALL, ALL_CATEGORIES, ALLWORDS, ANYWORDS, BOTH, CASE_SENSITIVE, CATGPENREL_BOTH_SCHEMA_TYPE, CATGPENREL_PRODUCT_SCHEMA_TYPE, COPYRIGHT, EXACTPHRASE, ITEM, LISTPRICE_ON, OPERATOR_EQUAL, OPERATOR_GREATER, OPERATOR_GREATER_EQUAL, OPERATOR_LESS, OPERATOR_LESS_EQUAL, OPERATOR_LIKE, OPERATOR_NOT_EQUAL, OPERATOR_NOT_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
 
Constructor Summary
CatEntrySearchListDataBean()
          Constructs a CatEntrySearchListDataBean.
 
Method Summary
 void execute()
          Calls the search interface to query the database.
 java.lang.String getBeginIndex()
          Returns beginIndex of type String
 int getBeginIndexInt()
          Returns beginIndex of type int.
 java.lang.String getCategoryTerm()
          Returns categoryTerm
 java.lang.String getCategoryTermCaseSensitive()
          Returns categoryTermCaseSensitive
 java.lang.String getCategoryTermOperator()
          Returns categoryTermOperator.
 java.lang.Integer getCategoryTermScope()
          Returns category term search scope
 java.lang.String getCategoryType()
          Returns category term search type
 java.lang.String getCatGroupId()
          Returns catGroupId
 java.lang.String getCatgrpSchemaType()
          Returns data population type in CATGPENREL table.
protected  MonetaryAmount getConvertedPrice(java.math.BigDecimal amount)
          Converts an input price value to a value in store default currency.
 java.lang.String getCurrency()
          Returns input currency
 java.lang.String getCurrencyCaseSensitive()
          Returns currencyCaseSensitive
 java.lang.String getCurrencyOperator()
          Returns currencyOperator.
 java.lang.String getFilterTerm()
          Returns filterTerm
 java.lang.String getFilterTermCaseSensitive()
          Returns filterTermCaseSensitive
 java.lang.String getFilterTermOperator()
          Returns filterTermOperator
 java.lang.String getFilterType()
          Returns filterType
 boolean getIsAllNull()
          Returns isAllNull
 java.lang.String getIsListPriceOn()
          Insert the method's description here.
 java.lang.String getManufacturer()
          Returns manufacturer
 java.lang.String getManufacturerCaseSensitive()
          Returns manufacturerCaseSensitive
 java.lang.String getManufacturerOperator()
          Returns manufacturerOperator
 java.lang.String getManufacturerPartNum()
          Returns manufacturerPartNum
 java.lang.String getManufacturerPartNumCaseSensitive()
          Returns manufacturerPartNumCaseSensitive
 java.lang.String getManufacturerPartNumOperator()
          Returns manufacturerPartNumOperator
 java.lang.String getMaxPrice()
          Returns maxPrice
 java.lang.String getMinPrice()
          Returns minPrice
protected  int getNumericOperator(java.lang.String opKey)
          The input search criteria operators are of type String.
 java.lang.String getPageSize()
          Return pageSize of type String
 int getPageSizeInt()
          Return pageSize of type int.
 java.lang.String getPrice()
          Returns Price.
 java.lang.String getPriceOperator()
          Returns priceOperator
 java.lang.String getQtyAvailable()
          Returns qtyAvailable
 java.lang.String getQtyAvailableOperator()
          Returns qtyAvailableOperator
 java.lang.String getQtyMeasure()
          Returns qtyMeasure.
 java.lang.String getQtyMeasureCaseSensitive()
          Returns qtyMeasureCaseSensitive.
 java.lang.String getQtyMeasureOperator()
          Returns qtyMeasureOperator.
 java.lang.String getRASchemaType()
          Returns RASchemaType
 java.lang.String getResultCount()
          Returns resultCount
 CatalogEntryDataBean[] getResultList()
          Returns CatalogEntryDataBean
 java.lang.String getResultType()
          Returns resultType
 java.lang.String getSearchTerm()
          Returns searchTerm
 java.lang.String getSearchTermCaseSensitive()
          Returns searchTermCaseSensitive.
 java.lang.String getSearchTermOperator()
          Returns searchTermOperator.
 java.lang.Integer getSearchTermScope()
          Returns searchTermScope.
 java.lang.String getSearchType()
          Returns searchType.
 java.lang.String getSku()
          Returns sku
 java.lang.String getSkuCaseSensitive()
          Returns skuCaseSensitive
 java.lang.String getSkuOperator()
          Returns skuOperator
protected  int getStringOperator(java.lang.String opKey)
          Converts Operators (LIKE,EQUAL,NOTLIKE) to search interface integer constant
 boolean isEmpty(java.lang.String str)
          Checks if a string is null or blank space.
 void populate()
          Populate the data bean
 void setBeginIndex(java.lang.String newBeginIndex)
          To set beginIndex.
 void setCategoryTerm(java.lang.String newCategoryTerm)
          To set categoryTerm.
 void setCategoryTermCaseSensitive(java.lang.String newCategoryTermCaseSensitive)
          To set categoryTermCaseSensitive.
 void setCategoryTermOperator(java.lang.String newCategoryTermOperator)
          To set categoryTermOperator.
 void setCategoryTermScope(java.lang.Integer newCategoryTermScope)
          To set categoryTermScope
 void setCategoryType(java.lang.String newCategoryType)
          To set categoryType.
 void setCatGroupId(java.lang.String newCatGroupId)
          To set catGroupId.
 void setCatgrpSchemaType(java.lang.String newCatgrpSchemaType)
          To set catgrpSchemaType.
 void setCurrency(java.lang.String newCurrency)
          To set currency.
 void setCurrencyCaseSensitive(java.lang.String newCurrencyCaseSensitive)
          To set currencyCaseSensitive.
 void setCurrencyOperator(java.lang.String newCurrencyOperator)
          To set currencyOperator.
 void setFilterTerm(java.lang.String newFilterTerm)
          To set filterTerm.
 void setFilterTermCaseSensitive(java.lang.String newFilterTermCaseSensitive)
          To set filterTermCaseSensitive.
 void setFilterTermOperator(java.lang.String newFilterTermOperator)
          To set filterTermOperator.
 void setFilterType(java.lang.String newFilterType)
          To set filterType.
 void setIsAllNull(boolean newIsAllNull)
          To set isAllNull.
 void setIsListPriceOn(java.lang.String newIsListPriceOn)
          To set isListPriceOn
 void setManufacturer(java.lang.String newManufacturer)
          To set manufacturer
 void setManufacturerCaseSensitive(java.lang.String newManufacturerCaseSensitive)
          To set manufacturerCaseSensitive.
 void setManufacturerOperator(java.lang.String newManufacturerOperator)
          To set manufacturerOperator.
 void setManufacturerPartNum(java.lang.String newManufacturerPartNum)
          To set manufacturerPartNum.
 void setManufacturerPartNumCaseSensitive(java.lang.String newManufacturerPartNumCaseSensitive)
          To set manufacturerPartNumCaseSensitive.
 void setManufacturerPartNumOperator(java.lang.String newManufacturerPartNumOperator)
          To set manufacturerPartNumOperator.
 void setMaxPrice(java.lang.String newMaxPrice)
          To set maxPrice.
 void setMinPrice(java.lang.String newMinPrice)
          To set minPrice.
 void setPageSize(java.lang.String newPageSize)
          To set pageSize.
 void setPredefinedAttributes()
          Constructs search predicate using search interface.
 void setPrice(java.lang.String newPrice)
          To set price.
 void setPriceOperator(java.lang.String newPriceOperator)
          To set priceOperator.
 void setQtyAvailable(java.lang.String newQtyAvailable)
          To set qtyAvailable.
 void setQtyAvailableOperator(java.lang.String newQtyAvailableOperator)
          To set qtyAvailableOperator.
 void setQtyMeasure(java.lang.String newQtyMeasure)
          To set qtyMeasure
 void setQtyMeasureCaseSensitive(java.lang.String newQtyMeasureCaseSensitive)
          To set qtyMeasureCaseSensitive.
 void setQtyMeasureOperator(java.lang.String newQtyMeasureOperator)
          To set qtyMeasureOperator.
 void setRASchemaType(java.lang.String newRASchemaType)
          To set RASchemaType.
 void setResultCount(java.lang.String newResultCount)
          To set resultCount.
 void setResultType(java.lang.String newResultType)
          To set resultType.
 void setRuleQuery(RuleQuery newRuleQuery)
          To set RuleQuery.
 void setSearchTerm(java.lang.String newSearchTerm)
          To set searchTerm.
 void setSearchTermCaseSensitive(java.lang.String newSearchTermCaseSensitive)
          To set searchTermCaseSensitive.
 void setSearchTermOperator(java.lang.String newSearchTermOperator)
          To set searchTermOperator.
 void setSearchTermScope(java.lang.Integer newSearchTermScope)
          To set searchTermScope.
 void setSearchType(java.lang.String newSearchType)
          To set searchType.
 void setSku(java.lang.String newSku)
          To set sku.
 void setSkuCaseSensitive(java.lang.String newSkuCaseSensitive)
          To set skuCaseSensitive.
 void setSkuOperator(java.lang.String newSkuOperator)
          To set skuOperator.
 

Field Detail

aCursor

protected com.ibm.commerce.search.beans.Cursor aCursor

beginIndex

protected java.lang.String beginIndex

categoryTerm

protected java.lang.String categoryTerm

categoryTermCaseSensitive

protected java.lang.String categoryTermCaseSensitive

categoryTermOperator

protected java.lang.String categoryTermOperator

categoryTermScope

protected java.lang.Integer categoryTermScope

categoryType

protected java.lang.String categoryType

catGroupId

protected java.lang.String catGroupId

catgrpSchemaType

protected java.lang.String catgrpSchemaType

currency

protected java.lang.String currency

currencyCaseSensitive

protected java.lang.String currencyCaseSensitive

currencyOperator

protected java.lang.String currencyOperator

filterTerm

protected java.lang.String filterTerm

filterTermCaseSensitive

protected java.lang.String filterTermCaseSensitive

filterTermOperator

protected java.lang.String filterTermOperator

filterType

protected java.lang.String filterType

isAllNull

protected boolean isAllNull

isListPriceOn

protected java.lang.String isListPriceOn

manufacturer

protected java.lang.String manufacturer

manufacturerCaseSensitive

protected java.lang.String manufacturerCaseSensitive

manufacturerOperator

protected java.lang.String manufacturerOperator

manufacturerPartNum

protected java.lang.String manufacturerPartNum

manufacturerPartNumCaseSensitive

protected java.lang.String manufacturerPartNumCaseSensitive

manufacturerPartNumOperator

protected java.lang.String manufacturerPartNumOperator

maxPrice

protected java.lang.String maxPrice

minPrice

protected java.lang.String minPrice

pageSize

protected java.lang.String pageSize

price

protected java.lang.String price

priceOperator

protected java.lang.String priceOperator

q

protected RuleQuery q

qtyAvailable

protected java.lang.String qtyAvailable

qtyAvailableOperator

protected java.lang.String qtyAvailableOperator

qtyMeasure

protected java.lang.String qtyMeasure

qtyMeasureCaseSensitive

protected java.lang.String qtyMeasureCaseSensitive

qtyMeasureOperator

protected java.lang.String qtyMeasureOperator

RASchemaType

protected java.lang.String RASchemaType

resultCount

protected java.lang.String resultCount

resultList

protected CatalogEntryDataBean[] resultList

resultType

protected java.lang.String resultType

searchTerm

protected java.lang.String searchTerm

searchTermCaseSensitive

protected java.lang.String searchTermCaseSensitive

searchTermOperator

protected java.lang.String searchTermOperator

searchTermScope

protected java.lang.Integer searchTermScope

searchType

protected java.lang.String searchType

sku

protected java.lang.String sku

skuCaseSensitive

protected java.lang.String skuCaseSensitive

skuOperator

protected java.lang.String skuOperator
Constructor Detail

CatEntrySearchListDataBean

public CatEntrySearchListDataBean()
Constructs a CatEntrySearchListDataBean.
Method Detail

execute

public void execute()
             throws java.lang.Exception
Calls the search interface to query the database.

getBeginIndex

public java.lang.String getBeginIndex()
Returns beginIndex of type String
Returns:
The starting index for a page

getBeginIndexInt

public int getBeginIndexInt()
Returns beginIndex of type int. The beginIndex of type int is used in constructing a Cursor.
Returns:
The starting index for a page.

getCategoryTerm

public java.lang.String getCategoryTerm()
Returns categoryTerm
Returns:
The input search criteria - Category Group Description.

getCategoryTermCaseSensitive

public java.lang.String getCategoryTermCaseSensitive()
Returns categoryTermCaseSensitive
Returns:
The search case (sensitive or insensitive) for category term search.

getCategoryTermOperator

public java.lang.String getCategoryTermOperator()
Returns categoryTermOperator.
Returns:
The search operator (EQUAL or LIKE) for category term search.

getCategoryTermScope

public java.lang.Integer getCategoryTermScope()
Returns category term search scope
Returns:
The search scope (database columns to search) for category term search.

getCategoryType

public java.lang.String getCategoryType()
Returns category term search type
Returns:
The search type (ALL, ANY or EXACT PHRASE) for category term search

getCatGroupId

public java.lang.String getCatGroupId()
Returns catGroupId
Returns:
The input search criteria - Category Group Identifier.

getCatgrpSchemaType

public java.lang.String getCatgrpSchemaType()
Returns data population type in CATGPENREL table.
Returns:
The schema type that represents the data population type in CATGPENREL table.

getConvertedPrice

protected MonetaryAmount getConvertedPrice(java.math.BigDecimal amount)
                                    throws java.lang.Exception
Converts an input price value to a value in store default currency.
Parameters:
amount - The price value to convert.
Returns:
The converted amount.

getCurrency

public java.lang.String getCurrency()
Returns input currency
Returns:
The input search criteria - Currency

getCurrencyCaseSensitive

public java.lang.String getCurrencyCaseSensitive()
Returns currencyCaseSensitive
Returns:
The search case (sensitive or insensitive) for currency search.

getCurrencyOperator

public java.lang.String getCurrencyOperator()
Returns currencyOperator.
Returns:
The search operator (EQUAL/LIKE) for currency search.

getFilterTerm

public java.lang.String getFilterTerm()
Returns filterTerm
Returns:
The input filter term that filters the search results.

getFilterTermCaseSensitive

public java.lang.String getFilterTermCaseSensitive()
Returns filterTermCaseSensitive
Returns:
The case (case sensitive or insesitive) for filter term.

getFilterTermOperator

public java.lang.String getFilterTermOperator()
Returns filterTermOperator
Returns:
The operator (EQUAL or LIKE) for filtering filterTerm.

getFilterType

public java.lang.String getFilterType()
Returns filterType
Returns:
The filter type (ALL, ANY or EXACT) for filtering the filterTerm.

getIsAllNull

public boolean getIsAllNull()
Returns isAllNull
Returns:
true if all the search criteria are null; false otherwise

getIsListPriceOn

public java.lang.String getIsListPriceOn()
Insert the method's description here.
Returns:
java.lang.String

getManufacturer

public java.lang.String getManufacturer()
Returns manufacturer
Returns:
The input search criteria - Manufacturer's Name

getManufacturerCaseSensitive

public java.lang.String getManufacturerCaseSensitive()
Returns manufacturerCaseSensitive
Returns:
The search case (case sensitive or insensitive) for manufacturer's name search.

getManufacturerOperator

public java.lang.String getManufacturerOperator()
Returns manufacturerOperator
Returns:
The search operator for searching manufacturer's name.

getManufacturerPartNum

public java.lang.String getManufacturerPartNum()
Returns manufacturerPartNum
Returns:
The input search criteria - manufacturer's part number.

getManufacturerPartNumCaseSensitive

public java.lang.String getManufacturerPartNumCaseSensitive()
Returns manufacturerPartNumCaseSensitive
Returns:
The search case (case sensitive or insensitive) for manufacturer's part number.

getManufacturerPartNumOperator

public java.lang.String getManufacturerPartNumOperator()
Returns manufacturerPartNumOperator
Returns:
The search operator for searching manufacturer's part number.

getMaxPrice

public java.lang.String getMaxPrice()
Returns maxPrice
Returns:
The input search criteria - Maximum Price.

getMinPrice

public java.lang.String getMinPrice()
Returns minPrice
Returns:
The input search criteria - Minimum Price

getNumericOperator

protected int getNumericOperator(java.lang.String opKey)
The input search criteria operators are of type String. This method converts numeric input operators ( =, >, >=, <=,<) of type String to an equivalent integer constant defined in search inteface class RuleQuery.
Parameters:
opKey - The input search criteria operator (numeric operator) of type String value.
Returns:
The integer value of a numeric operator defined in RuleQuery.

getPageSize

public java.lang.String getPageSize()
Return pageSize of type String
Returns:
The number of search result records to be dispalyed in a page.

getPageSizeInt

public int getPageSizeInt()
Return pageSize of type int. The pageSize of type int is used in constructing a Cursor.
Returns:
The number of search result records to be dispalyed in a page.

getPrice

public java.lang.String getPrice()
Returns Price.
Returns:
The input search criteria - Price

getPriceOperator

public java.lang.String getPriceOperator()
Returns priceOperator
Returns:
The search operator for searching Price

getQtyAvailable

public java.lang.String getQtyAvailable()
Returns qtyAvailable
Returns:
The input search criteria - Quantity Available.

getQtyAvailableOperator

public java.lang.String getQtyAvailableOperator()
Returns qtyAvailableOperator
Returns:
The search operator for searching Quantity Available.

getQtyMeasure

public java.lang.String getQtyMeasure()
Returns qtyMeasure.
Returns:
The input search criteria - Quantity Measure.

getQtyMeasureCaseSensitive

public java.lang.String getQtyMeasureCaseSensitive()
Returns qtyMeasureCaseSensitive.
Returns:
The search case (case sensitive or insensitive) for searching Quantity Measure.

getQtyMeasureOperator

public java.lang.String getQtyMeasureOperator()
Returns qtyMeasureOperator.
Returns:
The search operator for searching Quantity Measure.

getRASchemaType

public java.lang.String getRASchemaType()
Returns RASchemaType
Returns:
The data population type

getResultCount

public java.lang.String getResultCount()
Returns resultCount
Returns:
The number of rows retrieved for this search criteria.

getResultList

public CatalogEntryDataBean[] getResultList()
Returns CatalogEntryDataBean
Returns:
The results retrieved for the search criteria.

getResultType

public java.lang.String getResultType()
Returns resultType
Returns:
The result type (Products, Items or Both)

getSearchTerm

public java.lang.String getSearchTerm()
Returns searchTerm
Returns:
The input search criteria - Search term.

getSearchTermCaseSensitive

public java.lang.String getSearchTermCaseSensitive()
Returns searchTermCaseSensitive.
Returns:
The search case (case sensitive or insensitive) for searching the Search Term

getSearchTermOperator

public java.lang.String getSearchTermOperator()
Returns searchTermOperator.
Returns:
The search operator for searching the Search Term.

getSearchTermScope

public java.lang.Integer getSearchTermScope()
Returns searchTermScope.
Returns:
The search scope (database columns to search) for the Search Term.

getSearchType

public java.lang.String getSearchType()
Returns searchType.
Returns:
The search type (ALL, ANY or EXACT PHRASE) for the Search Term.

getSku

public java.lang.String getSku()
Returns sku
Returns:
The input search criteria - Product SKU.

getSkuCaseSensitive

public java.lang.String getSkuCaseSensitive()
Returns skuCaseSensitive
Returns:
The search case (case sensitive or insensitive) for searching SKU.

getSkuOperator

public java.lang.String getSkuOperator()
Returns skuOperator
Returns:
The search operator for searching SKU.

getStringOperator

protected int getStringOperator(java.lang.String opKey)
Converts Operators (LIKE,EQUAL,NOTLIKE) to search interface integer constant
Parameters:
opKey - The search interface constant for operators Like, Equal and Not Equal.
Returns:
 

isEmpty

public boolean isEmpty(java.lang.String str)
Checks if a string is null or blank space.
Parameters:
str - Input string that is to be checked for null or blank space.
Returns:
flase if null or space, true otherwise.

populate

public void populate()
              throws java.lang.Exception
Populate the data bean

setBeginIndex

public void setBeginIndex(java.lang.String newBeginIndex)
To set beginIndex. Creation date: (7/25/2001 9:54:41 AM)
Parameters:
newBeginIndex - int

setCategoryTerm

public void setCategoryTerm(java.lang.String newCategoryTerm)
To set categoryTerm.
Parameters:
newCategoryTerm - java.lang.String

setCategoryTermCaseSensitive

public void setCategoryTermCaseSensitive(java.lang.String newCategoryTermCaseSensitive)
To set categoryTermCaseSensitive.
Parameters:
newCategoryTermCaseSensitive - java.lang.String

setCategoryTermOperator

public void setCategoryTermOperator(java.lang.String newCategoryTermOperator)
To set categoryTermOperator.
Parameters:
newCategoryTermOperator - java.lang.String

setCategoryTermScope

public void setCategoryTermScope(java.lang.Integer newCategoryTermScope)
To set categoryTermScope
Parameters:
newCategoryScope - java.lang.Integer

setCategoryType

public void setCategoryType(java.lang.String newCategoryType)
To set categoryType.
Parameters:
newCategoryType - java.lang.String

setCatGroupId

public void setCatGroupId(java.lang.String newCatGroupId)
To set catGroupId.
Parameters:
newCatGroupId - java.lang.String

setCatgrpSchemaType

public void setCatgrpSchemaType(java.lang.String newCatgrpSchemaType)
To set catgrpSchemaType.
Parameters:
newCatgrpSchemaType - java.lang.String

setCurrency

public void setCurrency(java.lang.String newCurrency)
To set currency.
Parameters:
newCurrency - java.lang.String

setCurrencyCaseSensitive

public void setCurrencyCaseSensitive(java.lang.String newCurrencyCaseSensitive)
To set currencyCaseSensitive.
Parameters:
newCurrencyCaseSensitive - java.lang.String

setCurrencyOperator

public void setCurrencyOperator(java.lang.String newCurrencyOperator)
To set currencyOperator.
Parameters:
newCurrencyOperator - java.lang.String

setFilterTerm

public void setFilterTerm(java.lang.String newFilterTerm)
To set filterTerm.
Parameters:
newFilterTerm - java.lang.String

setFilterTermCaseSensitive

public void setFilterTermCaseSensitive(java.lang.String newFilterTermCaseSensitive)
To set filterTermCaseSensitive.
Parameters:
newFilterTermCaseSensitive - java.lang.String

setFilterTermOperator

public void setFilterTermOperator(java.lang.String newFilterTermOperator)
To set filterTermOperator.
Parameters:
newFilterTermOperator - java.lang.String

setFilterType

public void setFilterType(java.lang.String newFilterType)
To set filterType.
Parameters:
newFilterType - java.lang.Integer

setIsAllNull

public void setIsAllNull(boolean newIsAllNull)
To set isAllNull.
Parameters:
newIsAllNull - boolean

setIsListPriceOn

public void setIsListPriceOn(java.lang.String newIsListPriceOn)
To set isListPriceOn
Parameters:
newIsListPriceOn - java.lang.String

setManufacturer

public void setManufacturer(java.lang.String newManufacturer)
To set manufacturer
Parameters:
newManufacturer - java.lang.String

setManufacturerCaseSensitive

public void setManufacturerCaseSensitive(java.lang.String newManufacturerCaseSensitive)
To set manufacturerCaseSensitive.
Parameters:
newManufacturerCaseSensitive - java.lang.String

setManufacturerOperator

public void setManufacturerOperator(java.lang.String newManufacturerOperator)
To set manufacturerOperator.
Parameters:
newManufacturerOperator - java.lang.String

setManufacturerPartNum

public void setManufacturerPartNum(java.lang.String newManufacturerPartNum)
To set manufacturerPartNum.
Parameters:
newManufacturerPartNum - java.lang.String

setManufacturerPartNumCaseSensitive

public void setManufacturerPartNumCaseSensitive(java.lang.String newManufacturerPartNumCaseSensitive)
To set manufacturerPartNumCaseSensitive.
Parameters:
newManufacturerPartNumCaseSensitive - java.lang.String

setManufacturerPartNumOperator

public void setManufacturerPartNumOperator(java.lang.String newManufacturerPartNumOperator)
To set manufacturerPartNumOperator.
Parameters:
newManufacturerPartNumOperator - java.lang.String

setMaxPrice

public void setMaxPrice(java.lang.String newMaxPrice)
To set maxPrice.
Parameters:
newMaxPrice - java.lang.String

setMinPrice

public void setMinPrice(java.lang.String newMinPrice)
To set minPrice.
Parameters:
newMinPrice - java.lang.String

setPageSize

public void setPageSize(java.lang.String newPageSize)
To set pageSize.
Parameters:
newPageSize - int

setPredefinedAttributes

public void setPredefinedAttributes()
                             throws java.lang.Exception
Constructs search predicate using search interface.

setPrice

public void setPrice(java.lang.String newPrice)
To set price.
Parameters:
newPrice - java.lang.String

setPriceOperator

public void setPriceOperator(java.lang.String newPriceOperator)
To set priceOperator.
Parameters:
newPriceOperator - java.lang.String

setQtyAvailable

public void setQtyAvailable(java.lang.String newQtyAvailable)
To set qtyAvailable.
Parameters:
newQtyAvailable - java.lang.String

setQtyAvailableOperator

public void setQtyAvailableOperator(java.lang.String newQtyAvailableOperator)
To set qtyAvailableOperator.
Parameters:
newQtyAvailableOperator - java.lang.String

setQtyMeasure

public void setQtyMeasure(java.lang.String newQtyMeasure)
To set qtyMeasure
Parameters:
newQtyMeasure - java.lang.String

setQtyMeasureCaseSensitive

public void setQtyMeasureCaseSensitive(java.lang.String newQtyMeasureCaseSensitive)
To set qtyMeasureCaseSensitive.
Parameters:
newQtyMeasureCaseSensitive - java.lang.String

setQtyMeasureOperator

public void setQtyMeasureOperator(java.lang.String newQtyMeasureOperator)
To set qtyMeasureOperator.
Parameters:
newQtyMeasureOperator - java.lang.String

setRASchemaType

public void setRASchemaType(java.lang.String newRASchemaType)
To set RASchemaType.
Parameters:
newRASchemaType - java.lang.String

setResultCount

public void setResultCount(java.lang.String newResultCount)
To set resultCount.
Parameters:
newResultCount - java.lang.String

setResultType

public void setResultType(java.lang.String newResultType)
To set resultType.
Parameters:
newResultType - java.lang.Integer

setRuleQuery

public void setRuleQuery(RuleQuery newRuleQuery)
To set RuleQuery.
Parameters:
newRuleQuery - com.ibm.commerce.search.rulequery.RuleQuery

setSearchTerm

public void setSearchTerm(java.lang.String newSearchTerm)
To set searchTerm.
Parameters:
newKeyword - java.lang.String

setSearchTermCaseSensitive

public void setSearchTermCaseSensitive(java.lang.String newSearchTermCaseSensitive)
To set searchTermCaseSensitive.
Parameters:
newSearchTermCaseSensitive - java.lang.String

setSearchTermOperator

public void setSearchTermOperator(java.lang.String newSearchTermOperator)
To set searchTermOperator.
Parameters:
newSearchTermOperator - java.lang.String

setSearchTermScope

public void setSearchTermScope(java.lang.Integer newSearchTermScope)
To set searchTermScope.
Parameters:
newSearchTermScope - java.lang.Integer

setSearchType

public void setSearchType(java.lang.String newSearchType)
To set searchType.
Parameters:
newSearchType - java.lang.Integer

setSku

public void setSku(java.lang.String newSku)
To set sku.
Parameters:
newSku - java.lang.String

setSkuCaseSensitive

public void setSkuCaseSensitive(java.lang.String newSkuCaseSensitive)
To set skuCaseSensitive.
Parameters:
newSkuCaseSensitive - java.lang.String

setSkuOperator

public void setSkuOperator(java.lang.String newSkuOperator)
To set skuOperator.
Parameters:
newSkuOperator - java.lang.String