Field Detail

• resultList

  protected CatalogEntryDataBean[] resultList
  

  This variable contains the result of the search.

• searchType

  protected java.lang.String searchType
  

  The value in this variable determines the search criteria type of All, Any or Exact Phrase. The value must be 'ALL'(for All search criteria), 'ANY'(for Any search criteria) and 'EXACT'(for Exact phrase criteria).

• searchTermScope

  protected java.lang.Integer searchTermScope
  

  The value of this variable determines the scope of a search for a searchTerm value. The scope can be name; name and short description; or name, short description and long description; or keyword. 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). Case-insensitive search is not permitted on the long description column.

• categoryTerm

  protected java.lang.String categoryTerm
  

  The value of this variable is used in search on category name and/or descriptions (table columns searched: Catgrpdesc.name, Catgrpdesc.Shortdescription, Catgrpdesc.Longdescription).

• categoryTermOperator

  protected java.lang.String categoryTermOperator
  

  A user can choose either 'like' or 'equal' as search operators. The value in this variable determines the search operator: like or equal used in conjunction with categoryTerm. The value must be either 'LIKE'(for like operator) or 'EQUAL'(for equal operator).

• categoryTermScope

  protected java.lang.Integer categoryTermScope
  

  This variable determines the scope of a search based on categoryTerm to name; name and short description; or name, short description and long description. The value must be 1 (for name and short description), or 2 (for name only), or 3 (for name, short description and long description). Case insensitive search is not permitted on the long description column.

• filterType

  protected java.lang.String filterType
  

  The value of this variable determines the search criteria based on these three types of search: All, Any, Exact Phrase. The value must be 'ALL'(for All search criteria), 'ANY'(for Any search criteria) and 'EXACT'(for Exact phrase criteria).

• categoryType

  protected java.lang.String categoryType
  

  The value in this variable determine three possible search criteria All, Any, Exact Phrase. The value must be 'ALL'(for All search criteria), 'ANY'(for Any search criteria) and 'EXACT'(for Exact phrase criteria).

• catGroupId

  protected java.lang.String catGroupId
  

  The value of this variable is used in search on a category id (table columns searched: Catgpenrel.Catgroupid).

• catGroupIdOperator

  protected java.lang.String catGroupIdOperator
  

  This variable determines the search operators (=, <, >, !=, <=, >= or in) used in conjunction with the catGroupIdin a search. The value must be any one of the following: EQUAL,NOTEQUAL, GREATER,LESS,GREATER_EQUAL, LESS_EQUAL or IN.

• filterTerm

  protected java.lang.String filterTerm
  

  The value in this variable is used to filter a search on a specified value (table columns searched: Catentdesc.name, Catentdesc.Shortdescription, Catentdesc.Longdescription).

• filterTermOperator

  protected java.lang.String filterTermOperator
  

  The value in this variable is used to store a user's choice for the search operators 'like' or 'equal'. The value must be either 'LIKE'(for like operator) or 'EQUAL'(for equal operator).

• filterTermCaseSensitive

  protected java.lang.String filterTermCaseSensitive
  

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

• sku

  protected java.lang.String sku
  

  The value of this variable is used in search on SKU, searching table and column CATENTRY.PARTNUMBER.

• skuOperator

  protected java.lang.String skuOperator
  

  The value in this variable indicates if the like or equal search operator is used in a search for sku. The value must be either LIKE(for like operator) or EQUAL(for equal operator).

• skuCaseSensitive

  protected java.lang.String skuCaseSensitive
  

  The value in this variable indicates if a search on sku is case sensitive or not. The value must be either yes (case sensitive search) or no (case insensitive search).

• minPrice

  protected java.lang.String minPrice
  

  The value of this variable indicates the minimum price for a search using a price range (table columns searched: offerprice.currency, offerprice.price).

• price

  protected java.lang.String price
  

  The value of this variable is used in a search on price (table columns searched: offerprice.currency, offerprice.price).

• priceOperator

  protected java.lang.String priceOperator
  

  The value in this variable indicates the search operator: =, <, >, !=, <=, >= used on a search on price. The value must be any one of the following: EQUAL, NOTEQUAL, GREATER,LESS, GREATER_EQUAL, LESS_EQUAL.

• maxPrice

  protected java.lang.String maxPrice
  

  The value of this variable indicates the maximum price for a search using a price range (table columns searched: offerprice.currency, offerprice.price).

• qtyMeasure

  protected java.lang.String qtyMeasure
  

  The value of this variable is used in search on quantity measure (view columns searched: Invstvw.quantitymeasure).

• qtyMeasureOperator

  protected java.lang.String qtyMeasureOperator
  

  The value in this variable indicates if the like or equal search operator is used in qtyMeasure. The value must be either LIKE(for like operator) or EQUAL(for equal operator).

• qtyMeasureCaseSensitive

  protected java.lang.String qtyMeasureCaseSensitive
  

  The value in this variable indicates if a search on qtyMeasure is case sensitive or not. The value must be either yes (case sensitive search) or no (case insensitive search).

• isListPriceOn

  protected java.lang.String isListPriceOn
  

• qtyAvailable

  protected java.lang.String qtyAvailable
  

  The value of this variable is used in search on inventory of a product/item (view columns searched: Invstvw.qtyavailable).

• qtyAvailableOperator

  protected java.lang.String qtyAvailableOperator
  

  The value in this variable the search operator: =, <, >,!=, <=, >= used in search for qtyAvailable. The value must be any one of the following: EQUAL, NOTEQUAL, GREATER, LESS, GREATER_EQUAL, LESS_EQUAL.

• manufacturer

  protected java.lang.String manufacturer
  

  The value of this variable is used in search on a manufacturer's name (table columns searched: Catentry.Mfname).

• manufacturerOperator

  protected java.lang.String manufacturerOperator
  

  The value in this variable indicates if the like or equal search operator is used in a manufacturer search. The value must be either LIKE(for like operator) or EQUAL(for equal operator).

• manufacturerCaseSensitive

  protected java.lang.String manufacturerCaseSensitive
  

  The value in this variable indicates if a search involving manufacturer is case sensitive or not. The value must be either 'yes'(case sensitive search) or 'no'(case insensitive search).

• manufacturerPartNum

  protected java.lang.String manufacturerPartNum
  

  The value of this variable is used in search on a manufacturer's part number (table columns searched: Catentry.Mfpartnumber).

• manufacturerPartNumOperator

  protected java.lang.String manufacturerPartNumOperator
  

  The value in this variable indicates if the like or equal search operator is used in a manufacturerPartNum search. The value must be either LIKE(for like operator) or EQUAL(for equal operator).

• manufacturerPartNumCaseSensitive

  protected java.lang.String manufacturerPartNumCaseSensitive
  

  The value in this variable indicates if a search involving manufacturerPartNumOperator is case sensitive or not. The value must be either 'yes'(case sensitive search) or 'no'(case insensitive search).

• currency

  protected java.lang.String currency
  

  The value of this variable is used in search on a currency (table columns searched: Offerprice.Currency).

• currencyOperator

  protected java.lang.String currencyOperator
  

  The value in this variable indicates if the search operator like or equal is used for a search involving currency. The value must be either 'LIKE'(for like operator) or 'EQUAL'(for equal operator).

• currencyCaseSensitive

  protected java.lang.String currencyCaseSensitive
  

  The value in this variable indicates if a search using currency is case sensitive or not. The value must be either 'yes'(case sensitive search) or 'no'(case insensitive search).

• searchTerm

  protected java.lang.String searchTerm
  

  The value of this variable is used in search on a word (table columns searched: Catentdesc.name, Catentdesc.Shortdescription, Catentdesc.Longdescription).

• searchTermOperator

  protected java.lang.String searchTermOperator
  

  The value of this variable determines the search operator 'like' or 'equal' for a search on the searchTerm value. The value must be either 'LIKE'(for like operator) or 'EQUAL'(for equal operator).

• searchTermCaseSensitive

  protected java.lang.String searchTermCaseSensitive
  

  The value in this variable determines if a search for searchTerm is case sensitive or not. The value must be either 'yes'(case sensitive search) or 'no'(case insensitive search).

• categoryTermCaseSensitive

  protected java.lang.String categoryTermCaseSensitive
  

  The value in this variable is used to identify if a search using categoryTerm is case sensitive or not. The value must be either 'yes'(case sensitive search) or 'no'(case insensitive search). Case insensitive search is not permitted on the long description column.

• resultType

  protected java.lang.String resultType
  

  This field is deprecated and exists for backward compatibility only. Use the methods isPackage, isBundle, isProduct, isItem, or isDynamicKit.
  You can display products, 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 (Items only), 2 (Products only) or 3 (both products and items).

• resultCount

  protected java.lang.String resultCount
  

  This variable will contain the total number of results returned for a search.

• exceededResultSize

  protected boolean exceededResultSize
  

  This variable indicates whether the total number of results has exceeded maxResultSize limits of ProductSearchThreshold or not.

• catgrpSchemaType

  protected java.lang.String catgrpSchemaType
  

  The value in this variable indicates if the table CATGPENREL contains catalog entries of type products only or a mixture of products and items. The queries generated by the bean at runtime depends on type of data in CATGPENREL table. The value must be either 1 (the CATGPENREL has only products) or 2 (the CATGPENREL has both items and products).

• RASchemaType

  protected java.lang.String RASchemaType
  

• isAllNull

  protected boolean isAllNull
  

  This variable indicates that all the search criteria are set to null. The default is true.

• catalogId

  protected java.lang.String catalogId
  

  The value of this variable is used in a search on a catalog id (table columns searched: Catgpenrel.Catalogid).

• catalogIdOperator

  protected java.lang.String catalogIdOperator
  

  The value in this variable indicates the search operator: =, <, >, !=, <=, >= used in a search on catalogId. The value must be any one of the following: EQUAL, NOTEQUAL, GREATER, LESS, GREATER_EQUAL, LESS_EQUAL.

• distinct

  protected java.lang.String distinct
  

  This variable defines the SQL distinct qualifier. It is useful when using order by where distinct qualifier is not permitted.

• orderBy1

  protected java.lang.String orderBy1
  

  Result set will be sorted by this attribute. See AttributeInfoDictionary for the possible values.

• orderByOperator1

  protected java.lang.String orderByOperator1
  

  Attributes can be sorted by ascending (default) or descending order.

• fieldOperator1

  protected java.lang.String fieldOperator1
  

  The value in this variable indicates the search operator: =, <, >, !=, <=, >= used in a search on field1. The value must be any one of the following: EQUAL, NOTEQUAL, GREATER, LESS, GREATER_EQUAL, LESS_EQUAL.

• fieldOperator2

  protected java.lang.String fieldOperator2
  

  The value in this variable indicates the search operator: =, <, >, !=, <=, >= used in a search on field2. The value must be any one of the following: EQUAL, NOTEQUAL, GREATER, LESS, GREATER_EQUAL, LESS_EQUAL.

• fieldOperator3

  protected java.lang.String fieldOperator3
  

  The value in this variable indicates the search operator: =, <, >, !=, <=, >= used in a search on field3. The value must be any one of the following: EQUAL, NOTEQUAL, GREATER, LESS, GREATER_EQUAL, LESS_EQUAL.

• fieldOperator4

  protected java.lang.String fieldOperator4
  

  The value in this variable indicates if the like or equal search operator is used in a field4 search. The value must be either LIKE (for like operator) or EQUAL(for equal operator).

• fieldOperator5

  protected java.lang.String fieldOperator5
  

  The value in this variable indicates if the like or equal search operator is used in a field5 search. The value must be either LIKE (for like operator) or EQUAL(for equal operator).

• field1

  protected java.lang.String field1
  

  The value of this variable is used on a search on the respective table column CATENTRY.field1.

• field2

  protected java.lang.String field2
  

  The value of this variable is used on a search on the respective table column CATENTRY.field2.

• field3

  protected java.lang.String field3
  

  The value of this variable is used on a search on the respective table column CATENTRY.field3.

• field4

  protected java.lang.String field4
  

  The value of this variable is used on a search on the respective table column CATENTRY.field4.

• field5

  protected java.lang.String field5
  

  The value of this variable is used on a search on the respective table column CATENTRY.field5.

• fieldValueCaseSensitive4

  protected java.lang.String fieldValueCaseSensitive4
  

  The value in this variable indicates if a search on field4 is case sensitive or not. The value must be either yes (case sensitive search) or no (case insensitive search).

• fieldValueCaseSensitive5

  protected java.lang.String fieldValueCaseSensitive5
  

  The value in this variable indicates if a search on field5 is case sensitive or not. The value must be either yes (case sensitive search) or no (case insensitive search).

• attributeValueOperator1

  protected java.lang.String attributeValueOperator1
  

  This variable indicates if the like or equal search operator is used in a search on attributeValue1. The value must be either LIKE (for like operator) or EQUAL (for equal operator).

• attributeValueOperator10

  protected java.lang.String attributeValueOperator10
  

  This variable indicates if the like or equal search operator is used in a search on attributeValue10. The value must be either LIKE (for like operator) or EQUAL (for equal operator).

• attributeValueOperator9

  protected java.lang.String attributeValueOperator9
  

  This variable indicates if the like or equal search operator is used in a search on attributeValue9. The value must be either LIKE (for like operator) or EQUAL (for equal operator).

• attributeValueOperator8

  protected java.lang.String attributeValueOperator8
  

  This variable indicates if the like or equal search operator is used in a search on attributeValue8. The value must be either LIKE (for like operator) or EQUAL (for equal operator).

• attributeValueOperator7

  protected java.lang.String attributeValueOperator7
  

  This variable indicates if the like or equal search operator is used in a search on attributeValue7. The value must be either LIKE (for like operator) or EQUAL (for equal operator).

• attributeValueOperator6

  protected java.lang.String attributeValueOperator6
  

  This variable indicates if the like or equal search operator is used in a search on attributeValue6. The value must be either LIKE (for like operator) or EQUAL (for equal operator).

• attributeValueCaseSensitive

  protected java.lang.String attributeValueCaseSensitive
  

  This variable indicates if a search on attribute value term is case sensitive or case insensitive. The value must be set to yes to result in a case sensitive search. Any other value will result in a case insensitive search. This one variable applies to all attribute values.

• attributeName1

  protected java.lang.String attributeName1
  

  The value of this variable is used to search on the rich attribute name from the ATTRIBUTE table. The operator for this variable is always EQUAL. A corresponding attributeValue1 needs to be specified.

• attributeName10

  protected java.lang.String attributeName10
  

  The value of this variable is used to search on the rich attribute name from the ATTRIBUTE table. The operator for this variable is always EQUAL. A corresponding attributeValue10 needs to be specified.

• attributeName9

  protected java.lang.String attributeName9
  

  The value of this variable is used to search on the rich attribute name from the ATTRIBUTE table. The operator for this variable is always EQUAL. A corresponding attributeValue9 needs to be specified.

• attributeName8

  protected java.lang.String attributeName8
  

  The value of this variable is used to search on the rich attribute name from the ATTRIBUTE table. The operator for this variable is always EQUAL. A corresponding attributeValue8 needs to be specified.

• attributeName7

  protected java.lang.String attributeName7
  

  The value of this variable is used to search on the rich attribute name from the ATTRIBUTE table. The operator for this variable is always EQUAL. A corresponding attributeValue7 needs to be specified.

• attributeName6

  protected java.lang.String attributeName6
  

  The value of this variable is used to search on the rich attribute name from the ATTRIBUTE table. The operator for this variable is always EQUAL. A corresponding attributeValue6 needs to be specified.

• attributeName2

  protected java.lang.String attributeName2
  

  The value of this variable is used to search on the rich attribute name from the ATTRIBUTE table. The operator for this variable is always EQUAL. A corresponding attributeValue2 needs to be specified.

• attributeName3

  protected java.lang.String attributeName3
  

  The value of this variable is used to search on the rich attribute name from the ATTRIBUTE table. The operator for this variable is always EQUAL. A corresponding attributeValue3 needs to be specified.

• attributeName4

  protected java.lang.String attributeName4
  

  The value of this variable is used to search on the rich attribute name from the ATTRIBUTE table. The operator for this variable is always EQUAL. A corresponding attributeValue4 needs to be specified.

• attributeName5

  protected java.lang.String attributeName5
  

  The value of this variable is used to search on the rich attribute name from the ATTRIBUTE table. The operator for this variable is always EQUAL. A corresponding attributeValue5 needs to be specified.

• attributeValueType1

  protected java.lang.String attributeValueType1
  

  This variable indicates the type of the attributeValue1 search term. The attribute value type can be one of three values STRING, INTEGER or FLOAT corresponding to columns stringvalue, integervalue and floatvalue columns from the ATTRVALUE table.

• attributeValueType10

  protected java.lang.String attributeValueType10
  

  This variable indicates the type of the attributeValue10 search term. The attribute value type can be one of three values STRING, INTEGER or FLOAT corresponding to columns stringvalue, integervalue and floatvalue columns from the ATTRVALUE table.

• attributeValueType9

  protected java.lang.String attributeValueType9
  

  This variable indicates the type of the attributeValue9 search term. The attribute value type can be one of three values STRING, INTEGER or FLOAT corresponding to columns stringvalue, integervalue and floatvalue columns from the ATTRVALUE table.

• attributeValueType8

  protected java.lang.String attributeValueType8
  

  This variable indicates the type of the attributeValue8 search term. The attribute value type can be one of three values STRING, INTEGER or FLOAT corresponding to columns stringvalue, integervalue and floatvalue columns from the ATTRVALUE table.

• attributeValueType7

  protected java.lang.String attributeValueType7
  

  This variable indicates the type of the attributeValue7 search term. The attribute value type can be one of three values STRING, INTEGER or FLOAT corresponding to columns stringvalue, integervalue and floatvalue columns from the ATTRVALUE table.

• attributeValueType6

  protected java.lang.String attributeValueType6
  

  This variable indicates the type of the attributeValue6 search term. The attribute value type can be one of three values STRING, INTEGER or FLOAT corresponding to columns stringvalue, integervalue and floatvalue columns from the ATTRVALUE table.

• attributeValueType2

  protected java.lang.String attributeValueType2
  

  This variable indicates the type of the attributeValue2 search term. The attribute value type can be one of three values STRING, INTEGER or FLOAT corresponding to columns stringvalue, integervalue and floatvalue columns from the ATTRVALUE table.

• attributeValueType3

  protected java.lang.String attributeValueType3
  

  This variable indicates the type of the attributeValue3 search term. The attribute value type can be one of three values STRING, INTEGER or FLOAT corresponding to columns stringvalue, integervalue and floatvalue columns from the ATTRVALUE table.

• attributeValueType4

  protected java.lang.String attributeValueType4
  

  This variable indicates the type of the attributeValue4 search term. The attribute value type can be one of three values STRING, INTEGER or FLOAT corresponding to columns stringvalue, integervalue and floatvalue columns from the ATTRVALUE table.

• attributeValueType5

  protected java.lang.String attributeValueType5
  

  This variable indicates the type of the attributeValue5 search term. The attribute value type can be one of three values STRING, INTEGER or FLOAT corresponding to columns stringvalue, integervalue and floatvalue columns from the ATTRVALUE table.

• attributeValue1

  protected java.lang.String attributeValue1
  

  The value of this variable is the rich attribute value from ATTRVALUE table. A corresponding attributeName1 needs to be specified.

• attributeValue10

  protected java.lang.String attributeValue10
  

  The value of this variable is the rich attribute value from ATTRVALUE table. A corresponding attributeName10 needs to be specified.

• attributeValue9

  protected java.lang.String attributeValue9
  

  The value of this variable is the rich attribute value from ATTRVALUE table. A corresponding attributeName9 needs to be specified.

• attributeValue8

  protected java.lang.String attributeValue8
  

  The value of this variable is the rich attribute value from ATTRVALUE table. A corresponding attributeName8 needs to be specified.

• attributeValue7

  protected java.lang.String attributeValue7
  

  The value of this variable is the rich attribute value from ATTRVALUE table. A corresponding attributeName7 needs to be specified.

• attributeValue6

  protected java.lang.String attributeValue6
  

  The value of this variable is the rich attribute value from ATTRVALUE table. A corresponding attributeName6 needs to be specified.

• attributeValue2

  protected java.lang.String attributeValue2
  

  The value of this variable is the rich attribute value from ATTRVALUE table. A corresponding attributeName2 needs to be specified.

• attributeValue3

  protected java.lang.String attributeValue3
  

  The value of this variable is the rich attribute value from ATTRVALUE table. A corresponding attributeName3 needs to be specified.

• attributeValue4

  protected java.lang.String attributeValue4
  

  The value of this variable is the rich attribute value from ATTRVALUE table. A corresponding attributeName4 needs to be specified.

• attributeValue5

  protected java.lang.String attributeValue5
  

  The value of this variable is the rich attribute value from ATTRVALUE table. A corresponding attributeName5 needs to be specified.

• attributeValueOperator2

  protected java.lang.String attributeValueOperator2
  

  This variable indicates if the like or equal search operator is used in a search on attributeValue2. The value must be either LIKE (for like operator) or EQUAL (for equal operator).

• attributeValueOperator3

  protected java.lang.String attributeValueOperator3
  

  This variable indicates if the like or equal search operator is used in a search on attributeValue3. The value must be either LIKE (for like operator) or EQUAL (for equal operator).

• attributeValueOperator4

  protected java.lang.String attributeValueOperator4
  

  This variable indicates if the like or equal search operator is used in a search on attributeValue4. The value must be either LIKE (for like operator) or EQUAL (for equal operator).

• attributeValueOperator5

  protected java.lang.String attributeValueOperator5
  

  This variable indicates if the like or equal search operator is used in a search on attributeValue5. The value must be either LIKE (for like operator) or EQUAL (for equal operator).

• isItem

  protected boolean isItem
  

  This variable indicates if your resulting search can return catalog entries of type ItemBean. The possible values are true or false. It is false by default.

• isProduct

  protected boolean isProduct
  

  This variable indicates if your resulting search can return catalog entries of type ProductBean. The possible values are true or false. It is false by default.

• isBundle

  protected boolean isBundle
  

  This variable indicates if your resulting search can return catalog entries of type BundleBean. The possible values are true or false. It is false by default.

• isPackage

  protected boolean isPackage
  

  This variable indicates if your resulting search can return catalog entries of type PackageBean. The possible values are true or false. It is false by default.

• isDynamicKit

  protected boolean isDynamicKit
  

  This variable indicates if your resulting search can return catalog entries of type DynamicKitBean. The possible values are true or false. It is false by default.

• userId

  protected int userId
  

  This variable indicates the user id used to perform the search. Usually, the userId is obtained from the CommandContext. Alternatively, the setter can also be used.

• langId

  protected java.lang.String langId
  

  This variable indicates the language id used for terms search which are language dependent.

• coSearchSkuEnabled

  protected boolean coSearchSkuEnabled
  

• resultSetName

  protected java.util.Vector resultSetName
  

• resultName

  protected java.lang.String resultName
  

• STD_PRICE_VIEW

  protected static java.lang.String STD_PRICE_VIEW
  

  The view (or the query name)used in Standard Price search sub query

• STD_PRICE_QUERY_DB2

  protected static java.lang.String STD_PRICE_QUERY_DB2
  

  The DB2 standard price query defined in the SearchQueryResources property file

• STD_PRICE_QUERY_ORACLE

  protected static java.lang.String STD_PRICE_QUERY_ORACLE
  

  The Oracle standard price query defined in the SearchQueryResources property file

• MASTER_CATALOG_PRICE_LIST_IDS

  protected static java.lang.String MASTER_CATALOG_PRICE_LIST_IDS
  

  The place holder for the master catalog price list IDs in the price query.

• RESOURCE_BUNDLE_BASE_NAME

  protected static java.lang.String RESOURCE_BUNDLE_BASE_NAME
  

  The resource bundle name used to get the SQL statements. The name is com.ibm.commerce.search.base.SearchQueryResources.

• RESOURCE_BUNDLE

  protected static java.util.ResourceBundle RESOURCE_BUNDLE
  

  The resource bundle of RESOURCE_BUNDLE_BASE_NAME.

• isValid

  protected boolean isValid
  

  The value in this variable indicates the result of validateParameters() method. The variable is set to false if the validateParameters() finds an invalid value, including SQL injection, specified for any of the attributes of this bean which can be set from JSP. The variable is set to true if no invalid values are found.

• invalidParam

  protected java.lang.String invalidParam
  

  The value in this variable is set by validateParameters() method only if the method doesn't completes sucessfully. This variable indicates the name of an attribute of this bean which has an invalid value including SQL injection.

• invalidParamValue

  protected java.lang.String invalidParamValue
  

  The value in this variable is set by validateParameters() method only if the method doesn't completes sucessfully. This variable indicates the invalid value of an attribute of thid bean.

Constructor Detail

• CatEntrySearchListDataBean

  public CatEntrySearchListDataBean()
  

  Constructs a CatEntrySearchListDataBean.

Method Detail

• setUseCachedCollectionEnumeration

  public final void setUseCachedCollectionEnumeration(boolean abUseCachedCollectionEnumeration)
  

  Sets whether or not to return the query result as a CachedCollectionEnumeration.

  Parameters:

  abUseCachedCollectionEnumeration - true to indicate that the query result should be returned as a CachedCollectionEnumeration. When this is true, the caller must use the getCachedResult method to get the query results, and must not call the getResultSet and related methods.

• isUseCachedCollectionEnumeration

  public final boolean isUseCachedCollectionEnumeration()
  

  Returns the useCachedCollectionEnumeration property.

  Returns:

  true if the query result should be returned as a CachedCollectionEnumeration.

• getCachedResult

  public final CachedCollectionEnumeration getCachedResult()
  

  Returns the query result. The caller must have previously set the useCachedCollectionEnumeration property to true before the query was executed. Otherwise null is returned.

  Returns:

  the query result, or null. Each element in the enumeration is a List of column values.

• buildRichAttributeConstraint

  public RuleQuery buildRichAttributeConstraint(RuleQuery q)
                                         throws java.lang.Exception
  

  Build rich attribute (parametric) constraints.

  Parameters:

  q - The RuleQuery object used to execute the query.

  Returns:

  The RuleQuery object used to execute the query.

  Throws:

  java.lang.Exception

• buildFieldConstraint

  public RuleQuery buildFieldConstraint(RuleQuery q)
                                 throws java.lang.Exception
  

  Build constraints on field columns of Catentry table.

  Parameters:

  q - The RuleQuery object used to execute the query.

  Returns:

  The RuleQuery object used to execute the query.

  Throws:

  java.lang.Exception

• buildBooleanPredicate

  protected com.ibm.commerce.search.base.Predicate buildBooleanPredicate(java.lang.String aTerm,
                                                             java.lang.String aOperator,
                                                             java.lang.String aType,
                                                             java.lang.String caseSensitive,
                                                             int attrIdentity)
                                                                  throws java.lang.Exception
  

  Formulate a search predicate, to search on a Varchar or Char column. This method supports construction of boolean predicate and search based on case.

  Parameters:

  aTerm - The search term .

  aOperator - The search operator (can be EQUAL, LIKE, NOT_LIKE).

  aType - The 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).

  caseSensitive - The 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) or no (case insensitive)

  attrIdentity - The column to search on.

  Returns:

  the predicate.

  Throws:

  java.lang.Exception

• buildFilterTermBooleanPredicate

  protected com.ibm.commerce.search.base.Predicate buildFilterTermBooleanPredicate(java.lang.String aTerm,
                                                                       java.lang.String aOperator,
                                                                       java.lang.String aType,
                                                                       java.lang.String caseSensitive,
                                                                       int attrIdentity)
                                                                            throws java.lang.Exception
  

  Formulate a filter term predicate, to filter on a Varchar or Char column. This method supports construction of boolean predicate and filter based on case.

  Parameters:

  aTerm - The filter term.

  aOperator - The filter operator (can be EQUAL, LIKE, NOT_LIKE).

  aType - The user can specify three types of filter criteria All, Any, Exact Phrase. The value in this variable is used to store a user's filter criteria. The value must be ALL (for All search criteria), ANY (for Any search criteria) and EXACT (for Exact phrase criteria).

  caseSensitive - The user can choose case sensitive or case insensitive search. The value in this variable is used to identify if a filter is case sensitive or not. The value must be either yes (case sensitive) or no (case insensitive)

  attrIdentity - The column to filter on.

  Returns:

  the predicate.

  Throws:

  java.lang.Exception

• execute

  protected void execute()
                  throws java.lang.Exception
  

  Calls the search interface to query the database.

  Specified by:

  execute in class SearchBaseDataBean

  Throws:

  java.lang.Exception

• getCatalogId

  public java.lang.String getCatalogId()
  

  This method returns the catalog id used in the search.

  Returns:

  The catalog id used for the search.

• getCatalogIdOperator

  public java.lang.String getCatalogIdOperator()
  

  This method returns the catalog id operator used in the search.

  Returns:

  The catalog id operator used in the search.

• getAttributeName1

  public java.lang.String getAttributeName1()
  

  This method returns the search term used for the rich attribute NAME from the ATTRIBUTE table for a query involving attribute name, attribute value.

  Returns:

  The search term used for the rich attribute NAME from the ATTRIBUTE table for a query involving attribute name, attribute value.

• getAttributeName10

  public java.lang.String getAttributeName10()
  

  This method returns the search term used for the rich attribute NAME from the ATTRIBUTE table for a query involving attribute name, attribute value.

  Returns:

  The search term used for the rich attribute NAME from the ATTRIBUTE table for a query involving attribute name, attribute value.

• getAttributeName2

  public java.lang.String getAttributeName2()
  

  This method returns the search term used for the rich attribute NAME from the ATTRIBUTE table for a query involving attribute name, attribute value.

  Returns:

  The search term used for the rich attribute NAME from the ATTRIBUTE table for a query involving attribute name, attribute value.

• getAttributeName3

  public java.lang.String getAttributeName3()
  

  This method returns the search term used for the rich attribute NAME from the ATTRIBUTE table for a query involving attribute name, attribute value.

  Returns:

  The search term used for the rich attribute NAME from the ATTRIBUTE table for a query involving attribute name, attribute value.

• getAttributeName4

  public java.lang.String getAttributeName4()
  

  This method returns the search term used for the rich attribute NAME from the ATTRIBUTE table for a query involving attribute name, attribute value.

  Returns:

  The search term used for the rich attribute NAME from the ATTRIBUTE table for a query involving attribute name, attribute value.

• getAttributeName5

  public java.lang.String getAttributeName5()
  

  This method returns the search term used for the rich attribute NAME from the ATTRIBUTE table for a query involving attribute name, attribute value.

  Returns:

  The search term used for the rich attribute NAME from the ATTRIBUTE table for a query involving attribute name, attribute value.

• getAttributeName6

  public java.lang.String getAttributeName6()
  

  This method returns the search term used for the rich attribute NAME from the ATTRIBUTE table for a query involving attribute name, attribute value.

  Returns:

  The search term used for the rich attribute NAME from the ATTRIBUTE table for a query involving attribute name, attribute value.

• getAttributeName7

  public java.lang.String getAttributeName7()
  

  This method returns the search term used for the rich attribute NAME from the ATTRIBUTE table for a query involving attribute name, attribute value.

  Returns:

  The search term used for the rich attribute NAME from the ATTRIBUTE table for a query involving attribute name, attribute value.

• getAttributeName8

  public java.lang.String getAttributeName8()
  

  This method returns the search term used for the rich attribute NAME from the ATTRIBUTE table for a query involving attribute name, attribute value.

  Returns:

  The search term used for the rich attribute NAME from the ATTRIBUTE table for a query involving attribute name, attribute value.

• getAttributeName9

  public java.lang.String getAttributeName9()
  

  This method returns the search term used for the rich attribute NAME from the ATTRIBUTE table for a query involving attribute name, attribute value.

  Returns:

  The search term used for the rich attribute NAME from the ATTRIBUTE table for a query involving attribute name, attribute value.

• getAttributeType

  protected int getAttributeType(java.lang.String attrType)
  

  This method returns the integer representation of the type of the attribute value for a search involving attribute name, attribute value.

  Parameters:

  attrType - The possible types are: STRING, FLOAT and INTEGER.

  Returns:

  The integer value of the type of the attribute value. The default returned value is the inter asssociated to type STRING.

• getAttributeValue1

  public java.lang.String getAttributeValue1()
  

  This method returns the search term used for the rich attribute VALUE from the ATTRVALUE table for a query involving attribute name, attribute value.

  Returns:

  The search term used for the rich attribute VALUE from the ATTRVALUE table for a query involving attribute name, attribute value.

• getAttributeValue10

  public java.lang.String getAttributeValue10()
  

  This method returns the search term used for the rich attribute VALUE from the ATTRVALUE table for a query involving attribute name, attribute value.

  Returns:

  The search term used for the rich attribute VALUE from the ATTRVALUE table for a query involving attribute name, attribute value.

• getAttributeValue2

  public java.lang.String getAttributeValue2()
  

  This method returns the search term used for the rich attribute VALUE from the ATTRVALUE table for a query involving attribute name, attribute value.

  Returns:

  The search term used for the rich attribute VALUE from the ATTRVALUE table for a query involving attribute name, attribute value.

• getAttributeValue3

  public java.lang.String getAttributeValue3()
  

  This method returns the search term used for the rich attribute VALUE from the ATTRVALUE table for a query involving attribute name, attribute value.

  Returns:

  The search term used for the rich attribute VALUE from the ATTRVALUE table for a query involving attribute name, attribute value.

• getAttributeValue4

  public java.lang.String getAttributeValue4()
  

  This method returns the search term used for the rich attribute VALUE from the ATTRVALUE table for a query involving attribute name, attribute value.

  Returns:

  The search term used for the rich attribute VALUE from the ATTRVALUE table for a query involving attribute name, attribute value.

• getAttributeValue5

  public java.lang.String getAttributeValue5()
  

  This method returns the search term used for the rich attribute VALUE from the ATTRVALUE table for a query involving attribute name, attribute value.

  Returns:

  The search term used for the rich attribute VALUE from the ATTRVALUE table for a query involving attribute name, attribute value.

• getAttributeValue6

  public java.lang.String getAttributeValue6()
  

  This method returns the search term used for the rich attribute VALUE from the ATTRVALUE table for a query involving attribute name, attribute value.

  Returns:

  The search term used for the rich attribute VALUE from the ATTRVALUE table for a query involving attribute name, attribute value.

• getAttributeValue7

  public java.lang.String getAttributeValue7()
  

  This method returns the search term used for the rich attribute VALUE from the ATTRVALUE table for a query involving attribute name, attribute value.

  Returns:

  The search term used for the rich attribute VALUE from the ATTRVALUE table for a query involving attribute name, attribute value.

• getAttributeValue8

  public java.lang.String getAttributeValue8()
  

  This method returns the search term used for the rich attribute VALUE from the ATTRVALUE table for a query involving attribute name, attribute value.

  Returns:

  The search term used for the rich attribute VALUE from the ATTRVALUE table for a query involving attribute name, attribute value.

• getAttributeValue9

  public java.lang.String getAttributeValue9()
  

  This method returns the search term used for the rich attribute VALUE from the ATTRVALUE table for a query involving attribute name, attribute value.

  Returns:

  The search term used for the rich attribute VALUE from the ATTRVALUE table for a query involving attribute name, attribute value.

• getAttributeValueCaseSensitive

  public java.lang.String getAttributeValueCaseSensitive()
  

  This method returns the case sensitivity used for the rich attribute VALUE from the ATTRVALUE table for a query involving attribute name, attribute value.

  Returns:

  The case sensitivity used for the rich attribute VALUE from the ATTRVALUE table for a query involving attribute name, attribute value.

• getAttributeValueOperator1

  public java.lang.String getAttributeValueOperator1()
  

  This method returns the search operator LIKE or EQUAL used for the rich attribute VALUE from the ATTRVALUE table for a query involving attribute name, attribute value.

  Returns:

  The search operator LIKE or EQUAL used for the rich attribute VALUE from the ATTRVALUE table for a query involving attribute name, attribute value.

• getAttributeValueOperator10

  public java.lang.String getAttributeValueOperator10()
  

  This method returns the search operator LIKE or EQUAL used for the rich attribute VALUE from the ATTRVALUE table for a query involving attribute name, attribute value.

  Returns:

  The search operator LIKE or EQUAL used for the rich attribute VALUE from the ATTRVALUE table for a query involving attribute name, attribute value.

• getAttributeValueOperator2

  public java.lang.String getAttributeValueOperator2()
  

  This method returns the search operator LIKE or EQUAL used for the rich attribute VALUE from the ATTRVALUE table for a query involving attribute name, attribute value.

  Returns:

  The search operator LIKE or EQUAL used for the rich attribute VALUE from the ATTRVALUE table for a query involving attribute name, attribute value.

• getAttributeValueOperator3

  public java.lang.String getAttributeValueOperator3()
  

  This method returns the search operator LIKE or EQUAL used for the rich attribute VALUE from the ATTRVALUE table for a query involving attribute name, attribute value.

  Returns:

  The search operator LIKE or EQUAL used for the rich attribute VALUE from the ATTRVALUE table for a query involving attribute name, attribute value.

• getAttributeValueOperator4

  public java.lang.String getAttributeValueOperator4()
  

  This method returns the search operator LIKE or EQUAL used for the rich attribute VALUE from the ATTRVALUE table for a query involving attribute name, attribute value.

  Returns:

  The search operator LIKE or EQUAL used for the rich attribute VALUE from the ATTRVALUE table for a query involving attribute name, attribute value.

• getAttributeValueOperator5

  public java.lang.String getAttributeValueOperator5()
  

  This method returns the search operator LIKE or EQUAL used for the rich attribute VALUE from the ATTRVALUE table for a query involving attribute name, attribute value.

  Returns:

  The search operator LIKE or EQUAL used for the rich attribute VALUE from the ATTRVALUE table for a query involving attribute name, attribute value.

• getAttributeValueOperator6

  public java.lang.String getAttributeValueOperator6()
  

  This method returns the search operator LIKE or EQUAL used for the rich attribute VALUE from the ATTRVALUE table for a query involving attribute name, attribute value.

  Returns:

  The search operator LIKE or EQUAL used for the rich attribute VALUE from the ATTRVALUE table for a query involving attribute name, attribute value.

• getAttributeValueOperator7

  public java.lang.String getAttributeValueOperator7()
  

  This method returns the search operator LIKE or EQUAL used for the rich attribute VALUE from the ATTRVALUE table for a query involving attribute name, attribute value.

  Returns:

  The search operator LIKE or EQUAL used for the rich attribute VALUE from the ATTRVALUE table for a query involving attribute name, attribute value.

• getAttributeValueOperator8

  public java.lang.String getAttributeValueOperator8()
  

  This method returns the search operator LIKE or EQUAL used for the rich attribute VALUE from the ATTRVALUE table for a query involving attribute name, attribute value.

  Returns:

  The search operator LIKE or EQUAL used for the rich attribute VALUE from the ATTRVALUE table for a query involving attribute name, attribute value.

• getAttributeValueOperator9

  public java.lang.String getAttributeValueOperator9()
  

  This method returns the search operator LIKE or EQUAL used for the rich attribute VALUE from the ATTRVALUE table for a query involving attribute name, attribute value.

  Returns:

  The search operator LIKE or EQUAL used for the rich attribute VALUE from the ATTRVALUE table for a query involving attribute name, attribute value.

• getAttributeValueType1

  public java.lang.String getAttributeValueType1()
  

  This method returns one of the three possible types: STRING, FLOAT or INTEGER of the rich attribute VALUE from the ATTRVALUE table for a query involving attribute name, attribute value.

  Returns:

  One of the three possible types: STRING, FLOAT or INTEGER of the rich attribute VALUE from the ATTRVALUE table for a query involving attribute name, attribute value.

• getAttributeValueType10

  public java.lang.String getAttributeValueType10()
  

  This method returns one of the three possible types: STRING, FLOAT or INTEGER of the rich attribute VALUE from the ATTRVALUE table for a query involving attribute name, attribute value.

  Returns:

  One of the three possible types: STRING, FLOAT or INTEGER of the rich attribute VALUE from the ATTRVALUE table for a query involving attribute name, attribute value.

• getAttributeValueType2

  public java.lang.String getAttributeValueType2()
  

  This method returns one of the three possible types: STRING, FLOAT or INTEGER of the rich attribute VALUE from the ATTRVALUE table for a query involving attribute name, attribute value.

  Returns:

  One of the three possible types: STRING, FLOAT or INTEGER of the rich attribute VALUE from the ATTRVALUE table for a query involving attribute name, attribute value.

• getAttributeValueType3

  public java.lang.String getAttributeValueType3()
  

  This method returns one of the three possible types: STRING, FLOAT or INTEGER of the rich attribute VALUE from the ATTRVALUE table for a query involving attribute name, attribute value.

  Returns:

  One of the three possible types: STRING, FLOAT or INTEGER of the rich attribute VALUE from the ATTRVALUE table for a query involving attribute name, attribute value.

• getAttributeValueType4

  public java.lang.String getAttributeValueType4()
  

  This method returns one of the three possible types: STRING, FLOAT or INTEGER of the rich attribute VALUE from the ATTRVALUE table for a query involving attribute name, attribute value.

  Returns:

  One of the three possible types: STRING, FLOAT or INTEGER of the rich attribute VALUE from the ATTRVALUE table for a query involving attribute name, attribute value.

• getAttributeValueType5

  public java.lang.String getAttributeValueType5()
  

  This method returns one of the three possible types: STRING, FLOAT or INTEGER of the rich attribute VALUE from the ATTRVALUE table for a query involving attribute name, attribute value.

  Returns:

  One of the three possible types: STRING, FLOAT or INTEGER of the rich attribute VALUE from the ATTRVALUE table for a query involving attribute name, attribute value.

• getAttributeValueType6

  public java.lang.String getAttributeValueType6()
  

  This method returns one of the three possible types: STRING, FLOAT or INTEGER of the rich attribute VALUE from the ATTRVALUE table for a query involving attribute name, attribute value.

  Returns:

  One of the three possible types: STRING, FLOAT or INTEGER of the rich attribute VALUE from the ATTRVALUE table for a query involving attribute name, attribute value.

• getAttributeValueType7

  public java.lang.String getAttributeValueType7()
  

  This method returns one of the three possible types: STRING, FLOAT or INTEGER of the rich attribute VALUE from the ATTRVALUE table for a query involving attribute name, attribute value.

  Returns:

  One of the three possible types: STRING, FLOAT or INTEGER of the rich attribute VALUE from the ATTRVALUE table for a query involving attribute name, attribute value.

• getAttributeValueType8

  public java.lang.String getAttributeValueType8()
  

  This method returns one of the three possible types: STRING, FLOAT or INTEGER of the rich attribute VALUE from the ATTRVALUE table for a query involving attribute name, attribute value.

  Returns:

  One of the three possible types: STRING, FLOAT or INTEGER of the rich attribute VALUE from the ATTRVALUE table for a query involving attribute name, attribute value.

• getAttributeValueType9

  public java.lang.String getAttributeValueType9()
  

  This method returns one of the three possible types: STRING, FLOAT or INTEGER of the rich attribute VALUE from the ATTRVALUE table for a query involving attribute name, attribute value.

  Returns:

  One of the three possible types: STRING, FLOAT or INTEGER of the rich attribute VALUE from the ATTRVALUE table for a query involving attribute name, attribute value.

• getCategoryTerm

  public java.lang.String getCategoryTerm()
  

  This method returns the search term used in a predicate involving catalog group name, short description and/or long description.

  Specified by:

  getCategoryTerm in interface com.ibm.commerce.search.beans.CatEntrySearchListSmartDataBean

  Returns:

  The search term used in a predicate involving catalog group name, short description and/or long description.

• getCategoryTermCaseSensitive

  public java.lang.String getCategoryTermCaseSensitive()
  

  This method returns the case sensitivity used in a predicate involving catalog group name, short description and/or long description (categoryTerm).

  Specified by:

  getCategoryTermCaseSensitive in interface com.ibm.commerce.search.beans.CatEntrySearchListSmartDataBean

  Returns:

  yes for case sensitive ; no for case insensitive.

• getCategoryTermOperator

  public java.lang.String getCategoryTermOperator()
  

  This method returns the search operator used in a predicate involving catalog group name, short description and/or long description (categoryTerm).

  Specified by:

  getCategoryTermOperator in interface com.ibm.commerce.search.beans.CatEntrySearchListSmartDataBean

  Returns:

  EQUAL or LIKE

• getCategoryTermScope

  public java.lang.Integer getCategoryTermScope()
  

  This method returns the category term search scope used in a predicate involving catalog group name, short description and/or long description (categoryTerm). The scope can be restricted to name; name and short description; or name, short description and long description; or keyword.

  Specified by:

  getCategoryTermScope in interface com.ibm.commerce.search.beans.CatEntrySearchListSmartDataBean

  Returns:

  1 (for name and short description), or 2 (for name only), or 3 (for name, short description and long description) or 4 (for keyword)

• getCategoryType

  public java.lang.String getCategoryType()
  

  This method returns the search type used in a predicate involving catalog group name, short description and/or long description (categoryTerm).

  Specified by:

  getCategoryType in interface com.ibm.commerce.search.beans.CatEntrySearchListSmartDataBean

  Returns:

  The search type for category term search. Possible values are : ALL, ANY or EXACT.

• getCatGroupId

  public java.lang.String getCatGroupId()
  

  This method returns the catalog group identifier used in a search predicate.

  Specified by:

  getCatGroupId in interface com.ibm.commerce.search.beans.CatEntrySearchListSmartDataBean

  Returns:

  The catalog group identifier used in a search predicate.

• getCatGroupIdOperator

  public java.lang.String getCatGroupIdOperator()
  

  This method returns the catalog group identifier operator used in a search predicate.

  Returns:

  The possible values are: EQUAL,NOTEQUAL, GREATER,LESS,GREATER_EQUAL, LESS_EQUAL or IN.

• getCatgrpSchemaType

  public java.lang.String getCatgrpSchemaType()
  

  This method returns the data population type in CATGPENREL table.

  Returns:

  The value must be either 1 if the CATGPENREL has only products or 2 if the CATGPENREL has both items and products.

• getConvertedPrice

  protected MonetaryAmount getConvertedPrice(java.math.BigDecimal amount)
                                      throws java.lang.Exception
  

  This method converts an input price value to a value in store default currency. This method assumes that the currency code was specified before calling this method.

  Parameters:

  amount - The price value to convert.

  Returns:

  The converted amount in the store default currency.

  Throws:

  java.lang.Exception

• getCurrency

  public java.lang.String getCurrency()
  

  This method returns the search term for a search predicate using currency.

  Specified by:

  getCurrency in interface com.ibm.commerce.search.beans.CatEntrySearchListSmartDataBean

  Returns:

  The search term for a search predicate using currency.

• getCurrencyCaseSensitive

  public java.lang.String getCurrencyCaseSensitive()
  

  This method returns the case sensitivity for a search predicate using currency.

  Specified by:

  getCurrencyCaseSensitive in interface com.ibm.commerce.search.beans.CatEntrySearchListSmartDataBean

  Returns:

  yes for case sensitive; no for case insensitive.

• getCurrencyOperator

  public java.lang.String getCurrencyOperator()
  

  This method returns the search operator for a search predicate using currency.

  Specified by:

  getCurrencyOperator in interface com.ibm.commerce.search.beans.CatEntrySearchListSmartDataBean

  Returns:

  The possible values are: EQUAL or LIKE.

• getDistinct

  public java.lang.String getDistinct()
  

  This method returns the SQL distinct qualifier.

  Returns:

  yes if the SQL distinct qualifier is to be used.

• getFilterTerm

  public java.lang.String getFilterTerm()
  

  Returns filterTerm. 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).

  Specified by:

  getFilterTerm in interface com.ibm.commerce.search.beans.CatEntrySearchListSmartDataBean

  Returns:

  The input filter term that filters the search results.

• getFilterTermCaseSensitive

  public java.lang.String getFilterTermCaseSensitive()
  

  Returns filterTermCaseSensitive. 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).

  Specified by:

  getFilterTermCaseSensitive in interface com.ibm.commerce.search.beans.CatEntrySearchListSmartDataBean

  Returns:

  yes for case sensitive; no for case insensitive.

• getFilterTermOperator

  public java.lang.String getFilterTermOperator()
  

  Returns filterTermOperator. 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).

  Specified by:

  getFilterTermOperator in interface com.ibm.commerce.search.beans.CatEntrySearchListSmartDataBean

  Returns:

  The operator (EQUAL or LIKE) for filtering filterTerm.

• getFilterType

  public java.lang.String getFilterType()
  

  Returns filterType. 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).

  Specified by:

  getFilterType in interface com.ibm.commerce.search.beans.CatEntrySearchListSmartDataBean

  Returns:

  The filter type (ALL, ANY or EXACT) for filtering the filterTerm.

• getIsAllNull

  public boolean getIsAllNull()
  

  This method returns if all the search criteria are null.

  Returns:

  true if all the search criteria are null; false otherwise

• getIsListPriceOn

  public java.lang.String getIsListPriceOn()
  

  Returns isListPriceOn. Returns the flag representing the status of the List Price.

  Specified by:

  getIsListPriceOn in interface com.ibm.commerce.search.beans.CatEntrySearchListSmartDataBean

  Returns:

  java.lang.String

• getLangId

  public java.lang.String getLangId()
  

  Returns langId. Returns the langauge Id used by the search.

  Returns:

  java.lang.String

• getManufacturer

  public java.lang.String getManufacturer()
  

  Returns manufacturer. manufacturer (String) : The value of this variable is used in search on a manufacturer's name (table columns searched: Catentry.Mfname).

  Specified by:

  getManufacturer in interface com.ibm.commerce.search.beans.CatEntrySearchListSmartDataBean

  Returns:

  The input search criteria - Manufacturer's Name

• getManufacturerCaseSensitive

  public java.lang.String getManufacturerCaseSensitive()
  

  Returns manufacturerCaseSensitive. 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).

  Specified by:

  getManufacturerCaseSensitive in interface com.ibm.commerce.search.beans.CatEntrySearchListSmartDataBean

  Returns:

  yes for case sensitive; no for case insensitive.

• getManufacturerOperator

  public java.lang.String getManufacturerOperator()
  

  Returns manufacturerOperator. 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).

  Specified by:

  getManufacturerOperator in interface com.ibm.commerce.search.beans.CatEntrySearchListSmartDataBean

  Returns:

  The search operator for searching manufacturer's name.

• getManufacturerPartNum

  public java.lang.String getManufacturerPartNum()
  

  Returns manufacturerPartNum. manufacturerPartNum (String) :The value of this variable is used in search on a manufacturer's part number (table columns searched: Catentry.Mfpartnumber).

  Specified by:

  getManufacturerPartNum in interface com.ibm.commerce.search.beans.CatEntrySearchListSmartDataBean

  Returns:

  The input search criteria - manufacturer's part number.

• getManufacturerPartNumCaseSensitive

  public java.lang.String getManufacturerPartNumCaseSensitive()
  

  Returns manufacturerPartNumCaseSensitive. 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).

  Specified by:

  getManufacturerPartNumCaseSensitive in interface com.ibm.commerce.search.beans.CatEntrySearchListSmartDataBean

  Returns:

  yes for case sensitive; no for case insensitive.

• getManufacturerPartNumOperator

  public java.lang.String getManufacturerPartNumOperator()
  

  Returns manufacturerPartNumOperator. 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).

  Specified by:

  getManufacturerPartNumOperator in interface com.ibm.commerce.search.beans.CatEntrySearchListSmartDataBean

  Returns:

  The search operator for searching manufacturer's part number.

• getMaxPrice

  public java.lang.String getMaxPrice()
  

  Returns maxPrice. maxPrice (String) : The values of this variable is used in search on price range (table columns searched: offerprice.currency, offerprice.price).

  Specified by:

  getMaxPrice in interface com.ibm.commerce.search.beans.CatEntrySearchListSmartDataBean

  Returns:

  The input search criteria - Maximum Price.

• getMinPrice

  public java.lang.String getMinPrice()
  

  Returns minPrice. minPrice (String) : The value of this variable is used in search on price range (table columns searched: offerprice.currency, offerprice.price).

  Specified by:

  getMinPrice in interface com.ibm.commerce.search.beans.CatEntrySearchListSmartDataBean

  Returns:

  The input search criteria - Minimum Price

• getOrderBy1

  public java.lang.String getOrderBy1()
  

  Returns orderBy1. orderBy1 (String): Result set will be sorted by this attribute.

  Returns:

  java.lang.String

• getOrderByOperator1

  public java.lang.String getOrderByOperator1()
  

  Returns orderByOperator1. orderByOperator1 (String): Attributes can be sorted by ascending (default) or descending order.

  Returns:

  java.lang.String

• getPrice

  public java.lang.String getPrice()
  

  Returns Price. price (String) : The value of this variable is used in search on price (table columns searched: offerprice.currency, offerprice.price).

  Specified by:

  getPrice in interface com.ibm.commerce.search.beans.CatEntrySearchListSmartDataBean

  Returns:

  The input search criteria - Price

• getPriceOperator

  public java.lang.String getPriceOperator()
  

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

  Specified by:

  getPriceOperator in interface com.ibm.commerce.search.beans.CatEntrySearchListSmartDataBean

  Returns:

  The search operator for searching Price

• getQtyAvailable

  public java.lang.String getQtyAvailable()
  

  Returns qtyAvailable. qtyAvailable (String) : The value of this variable is used in search on inventory of a product/item (view columns searched: Invstvw.Quantity_Available).

  Specified by:

  getQtyAvailable in interface com.ibm.commerce.search.beans.CatEntrySearchListSmartDataBean

  Returns:

  The input search criteria - Quantity Available.

• getQtyAvailableOperator

  public java.lang.String getQtyAvailableOperator()
  

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

  Specified by:

  getQtyAvailableOperator in interface com.ibm.commerce.search.beans.CatEntrySearchListSmartDataBean

  Returns:

  The search operator for searching Quantity Available.

• getQtyMeasure

  public java.lang.String getQtyMeasure()
  

  Returns qtyMeasure. qtyMeasure (String) : The value of this variable is used in search on quantity measure (view columns searched: Invstvw.Quantity_Measure).

  Specified by:

  getQtyMeasure in interface com.ibm.commerce.search.beans.CatEntrySearchListSmartDataBean

  Returns:

  The input search criteria - Quantity Measure.

• getQtyMeasureCaseSensitive

  public java.lang.String getQtyMeasureCaseSensitive()
  

  Returns qtyMeasureCaseSensitive. 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).

  Specified by:

  getQtyMeasureCaseSensitive in interface com.ibm.commerce.search.beans.CatEntrySearchListSmartDataBean

  Returns:

  yes for case sensitive; no for case insensitive.

• getQtyMeasureOperator

  public java.lang.String getQtyMeasureOperator()
  

  Returns qtyMeasureOperator.

  Specified by:

  getQtyMeasureOperator in interface com.ibm.commerce.search.beans.CatEntrySearchListSmartDataBean

  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. resultCount (String) : This variable will contain total number of results returned for a search.

  Specified by:

  getResultCount in interface com.ibm.commerce.search.beans.CatEntrySearchListSmartDataBean

  Overrides:

  getResultCount in class SearchBaseDataBean

  Returns:

  The number of rows retrieved for this search criteria.

• getExceededResultSize

  public boolean getExceededResultSize()
  

  This method indicates whether the total number of results has exceeded maxResultSize limits of ProductSearchThreshold or not.

  Returns:

  true if limits exceeded false otherwise.

• getResultList

  public CatalogEntryDataBean[] getResultList()
  

  Returns CatalogEntryDataBean

  Specified by:

  getResultList in interface com.ibm.commerce.search.beans.CatEntrySearchListSmartDataBean

  Returns:

  The results retrieved for the search criteria.

• getResultName

  public java.lang.String getResultName()
  

  Returns resultName.

  Returns:

  java.lang.String

• getResultSet

  public java.util.Vector getResultSet()
  

  Returns resultSet.

  Returns:

  java.util.Vector

• getResultSetName

  public java.util.Vector getResultSetName()
  

  Returns resultSetName.

  Returns:

  java.lang.String

• getResultType

  public java.lang.String getResultType()
  

  Deprecated. This method is deprecated and exists for backward compatibility only. Use the methods isPackage, isBundle, isProduct, isItem, or isDynamicKit.
  Returns resultType. resultType (String) : You can display products, 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 (Items only), 2 (Products only) or 3 (both products and items). This field is deprecated and exists for backward compatibility only. Use the methods isPackage, isBundle, isProduct, isItem, or isDynamicKit.

  Specified by:

  getResultType in interface com.ibm.commerce.search.beans.CatEntrySearchListSmartDataBean

  Returns:

  The result type (Products, Items or Both)

• getSearchTerm

  public java.lang.String getSearchTerm()
  

  Returns searchTerm. searchTerm(String) : The value of this variable is used in search on a word (table columns searched: Catentdesc.name, Catentdesc.Shortdescription, Catentdesc.Longdescription).

  Specified by:

  getSearchTerm in interface com.ibm.commerce.search.beans.CatEntrySearchListSmartDataBean

  Returns:

  The input search criteria - Search term.

• getSearchTermCaseSensitive

  public java.lang.String getSearchTermCaseSensitive()
  

  Returns searchTermCaseSensitive. 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).

  Specified by:

  getSearchTermCaseSensitive in interface com.ibm.commerce.search.beans.CatEntrySearchListSmartDataBean

  Returns:

  yes for case sensitive; no for case insensitive.

• getSearchTermOperator

  public java.lang.String getSearchTermOperator()
  

  Returns searchTermOperator. 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).

  Specified by:

  getSearchTermOperator in interface com.ibm.commerce.search.beans.CatEntrySearchListSmartDataBean

  Returns:

  The search operator for searching the Search Term.

• getSearchTermScope

  public java.lang.Integer getSearchTermScope()
  

  Returns searchTermScope. 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). Case-insensitive search is not permitted on the long description column. 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). Case-insensitive search is not permitted on the long description column.

  Specified by:

  getSearchTermScope in interface com.ibm.commerce.search.beans.CatEntrySearchListSmartDataBean

  Returns:

  The search scope (database columns to search) for the Search Term.

• getSearchType

  public java.lang.String getSearchType()
  

  Returns searchType. 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).

  Specified by:

  getSearchType in interface com.ibm.commerce.search.beans.CatEntrySearchListSmartDataBean

  Returns:

  The search type (ALL, ANY or EXACT PHRASE) for the Search Term.

• getSku

  public java.lang.String getSku()
  

  Returns sku. sku(String) : The value of this variable is used in search on SKU, searching table and column CATENTRY.PARTNUMBER.

  Specified by:

  getSku in interface com.ibm.commerce.search.beans.CatEntrySearchListSmartDataBean

  Returns:

  The input search criteria - Product SKU.

• getSkuCaseSensitive

  public java.lang.String getSkuCaseSensitive()
  

  Returns skuCaseSensitive. 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).

  Specified by:

  getSkuCaseSensitive in interface com.ibm.commerce.search.beans.CatEntrySearchListSmartDataBean

  Returns:

  yes for case sensitive; no for case insensitive.

• getSkuOperator

  public java.lang.String getSkuOperator()
  

  Returns skuOperator. 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).

  Specified by:

  getSkuOperator in interface com.ibm.commerce.search.beans.CatEntrySearchListSmartDataBean

  Returns:

  The search operator for searching SKU.

• getUserId

  public int getUserId()
  

  Returns userId. The user ID used by the search.

  Returns:

  int

• initialize

  protected void initialize()
                     throws java.lang.Exception
  

  This method initializes the data bean with command context. From the command context, the user id and store id will be retrieved and set. If the language id is not yet defined, it will also be set from the command context.

  Overrides:

  initialize in class SearchBaseDataBean

  Throws:

  java.lang.Exception

• isCoSearchSkuEnabled

  public boolean isCoSearchSkuEnabled()
  

  Returns coSearchSkuEnabled.

  Returns:

  boolean

• isIsBundle

  public boolean isIsBundle()
  

  This method returns if the search should return catalog entries of type BundleBean.

  Returns:

  true to return catalog entries of type BundleBean; false otherwise.

• isIsDynamicKit

  public boolean isIsDynamicKit()
  

  This method returns if the search should return catalog entries of type DynamicKitBean.

  Returns:

  true to return catalog entries of type DynamicKitBean; false otherwise.

• isIsItem

  public boolean isIsItem()
  

  This method returns if the search should return catalog entries of type ItemBean.

  Returns:

  true to return catalog entries of type ItemBean; false otherwise.

• isIsPackage

  public boolean isIsPackage()
  

  This method returns if the search should return catalog entries of type PackageBean.

  Returns:

  true to return catalog entries of type PackageBean; false otherwise.

• isIsProduct

  public boolean isIsProduct()
  

  This method returns if the search should return catalog entries of type ProductBean.

  Returns:

  btrue to return catalog entries of type ProductBean; false otherwise.

• populate

  public void populate()
                throws java.lang.Exception
  

  Populate the data bean

  Specified by:

  populate in interface SmartDataBean

  Specified by:

  populate in class SearchBaseDataBean

  Throws:

  java.lang.Exception

• convertPrice

  protected MonetaryAmount convertPrice(java.lang.String strPrice,
                            java.lang.String strCurrency)
                                 throws java.lang.Exception
  

  This method converts the formatted price string into MonetaryAmount object using store default currency.

  Parameters:

  strPrice - The formatted price string.

  strCurrency - The currency.

  Returns:

  the MonetaryAmount object in store default currency.

  Throws:

  java.lang.Exception - problem occurs while converting the price.

• constructPriceSearchQuery

  protected java.lang.String constructPriceSearchQuery()
                                                throws java.lang.Exception
  

  This method constructs the price range search sub query. Catentry_ID should be returned in the result set.

  Returns:

  The price range search sub query.

  Throws:

  java.lang.Exception - problem occurs while constructing the query.

• processRichAttribute

  protected RuleQuery processRichAttribute(RuleQuery q,
                               java.lang.String attributeName,
                               java.lang.String attributeValueType,
                               java.lang.String attributeValue,
                               java.lang.String attributeValueOperator)
                                    throws java.lang.Exception
  

  Defines rich attribute constraints.

  Parameters:

  q - the query

  attributeName - the attribute name

  attributeValueType - the attribute value type

  attributeValue - the attribute value

  attributeValueOperator - the attrbute value operator

  Returns:

  the query q.

  Throws:

  java.lang.Exception

• processFieldAttributes

  protected RuleQuery processFieldAttributes(RuleQuery q,
                                 java.lang.String fieldValue,
                                 java.lang.String fieldOperator,
                                 java.lang.String fieldValueCaseSensitive,
                                 int attrNum,
                                 int colNum)
                                      throws java.lang.Exception
  

  Defines field column constraints of the Catentry table.

  Parameters:

  q - the query

  fieldValue - the field value

  fieldOperator - the field operator

  fieldValueCaseSensitive - the case sensitive field value

  attrNum - the attribute number

  colNum - the column number

  Returns:

  the query q.

  Throws:

  java.lang.Exception

• setCatalogId

  public void setCatalogId(java.lang.String newCatalogId)
  

  To set catalogId.

  Parameters:

  newCatalogId - java.lang.String. The catalog ID.

• setCatalogIdOperator

  public void setCatalogIdOperator(java.lang.String newCatalogIdOperator)
  

  To set catalogIdOperator.

  Parameters:

  newCatalogIdOperator - java.lang.String. The catalog ID operator.

• setAttributeName1

  public void setAttributeName1(java.lang.String newAttributeName1)
  

  The value of this variable is the rich attribute NAME from the Attribute table.

  Parameters:

  newAttributeName1 - java.lang.String. Attribute name 1.

• setAttributeName10

  public void setAttributeName10(java.lang.String newAttributeName10)
  

  The value of this variable is the rich attribute NAME from the Attribute table.

  Parameters:

  newAttributeName10 - java.lang.String. Attribute name 10.

• setAttributeName2

  public void setAttributeName2(java.lang.String newAttributeName2)
  

  The value of this variable is the rich attribute NAME from the Attribute table.

  Parameters:

  newAttributeName2 - java.lang.String. Attribute name 2.

• setAttributeName3

  public void setAttributeName3(java.lang.String newAttributeName3)
  

  The value of this variable is the rich attribute NAME from the Attribute table.

  Parameters:

  newAttributeName3 - java.lang.String. Attribute name 3.

• setAttributeName4

  public void setAttributeName4(java.lang.String newAttributeName4)
  

  The value of this variable is the rich attribute NAME from the Attribute table.

  Parameters:

  newAttributeName4 - java.lang.String. Attribute name 4.

• setAttributeName5

  public void setAttributeName5(java.lang.String newAttributeName5)
  

  The value of this variable is the rich attribute NAME from the Attribute table.

  Parameters:

  newAttributeName5 - java.lang.String. Attribute name 5.

• setAttributeName6

  public void setAttributeName6(java.lang.String newAttributeName6)
  

  The value of this variable is the rich attribute NAME from the Attribute table.

  Parameters:

  newAttributeName6 - java.lang.String. Attribute name 6.

• setAttributeName7

  public void setAttributeName7(java.lang.String newAttributeName7)
  

  The value of this variable is the rich attribute NAME from the Attribute table.

  Parameters:

  newAttributeName7 - java.lang.String. Attribute name 7.

• setAttributeName8

  public void setAttributeName8(java.lang.String newAttributeName8)
  

  The value of this variable is the rich attribute NAME from the Attribute table.

  Parameters:

  newAttributeName8 - java.lang.String. Attribute name 8.

• setAttributeName9

  public void setAttributeName9(java.lang.String newAttributeName9)
  

  The value of this variable is the rich attribute NAME from the Attribute table.

  Parameters:

  newAttributeName9 - java.lang.String. Attribute name 9.

• setAttributeValue1

  public void setAttributeValue1(java.lang.String newAttributeValue1)
  

  The value of this variable is the rich attribute value from AttrValue table.

  Parameters:

  newAttributeValue1 - java.lang.String. Attribute value 1.

• setAttributeValue10

  public void setAttributeValue10(java.lang.String newAttributeValue10)
  

  The value of this variable is the rich attribute value from AttrValue table.

  Parameters:

  newAttributeValue10 - java.lang.String. Attribute value 10.

• setAttributeValue2

  public void setAttributeValue2(java.lang.String newAttributeValue2)
  

  The value of this variable is the rich attribute value from AttrValue table.

  Parameters:

  newAttributeValue2 - java.lang.String. . Attribute value 2.

• setAttributeValue3

  public void setAttributeValue3(java.lang.String newAttributeValue3)
  

  The value of this variable is the rich attribute value from AttrValue table.

  Parameters:

  newAttributeValue3 - java.lang.String. Attribute value 3.

• setAttributeValue4

  public void setAttributeValue4(java.lang.String newAttributeValue4)
  

  The value of this variable is the rich attribute value from AttrValue table.

  Parameters:

  newAttributeValue4 - java.lang.String. Attribute value 4.

• setAttributeValue5

  public void setAttributeValue5(java.lang.String newAttributeValue5)
  

  The value of this variable is the rich attribute value from AttrValue table.

  Parameters:

  newAttributeValue5 - java.lang.String. Attribute value 5.

• setAttributeValue6

  public void setAttributeValue6(java.lang.String newAttributeValue6)
  

  The value of this variable is the rich attribute value from AttrValue table.

  Parameters:

  newAttributeValue6 - java.lang.String. Attribute value 6.

• setAttributeValue7

  public void setAttributeValue7(java.lang.String newAttributeValue7)
  

  The value of this variable is the rich attribute value from AttrValue table.

  Parameters:

  newAttributeValue7 - java.lang.String. Attribute value 7.

• setAttributeValue8

  public void setAttributeValue8(java.lang.String newAttributeValue8)
  

  The value of this variable is the rich attribute value from AttrValue table.

  Parameters:

  newAttributeValue8 - java.lang.String. Attribute value 8.

• setAttributeValue9

  public void setAttributeValue9(java.lang.String newAttributeValue9)
  

  The value of this variable is the rich attribute value from AttrValue table.

  Parameters:

  newAttributeValue9 - java.lang.String. Attribute value 9.

• setAttributeValueCaseSensitive

  public void setAttributeValueCaseSensitive(java.lang.String newAttributeValueCaseSensitive)
  

  A user can choose case sensitive or case insensitive specification of attribute value search. The value in this variable is used to identify if value term in AttrValue table is case sensitive or not. The value must be either 'yes'(case sensitive search) or 'no'(case insensitive search). There is only one variable and it applies to all attribute values.

  Parameters:

  newAttributeValueCaseSensitive - java.lang.String. The attribute value case sensitive setting, either 'yes', or 'no'.

• setAttributeValueOperator1

  public void setAttributeValueOperator1(java.lang.String newAttributeValueOperator1)
  

  A user can choose a search operators for attribute value operation. The value must be either 'LIKE'(for like operator) or 'EQUAL'(for equal operator).

  Parameters:

  newAttributeValueOperator1 - java.lang.String. The attribute value 1 operator, either 'LIKE' or 'EQUAL'.

• setAttributeValueOperator10

  public void setAttributeValueOperator10(java.lang.String newAttributeValueOperator10)
  

  A user can choose a search operators for attribute value operation. The value must be either 'LIKE'(for like operator) or 'EQUAL'(for equal operator).

  Parameters:

  newAttributeValueOperator10 - java.lang.String. The attribute value 10 operator, either 'LIKE' or 'EQUAL'.

• setAttributeValueOperator2

  public void setAttributeValueOperator2(java.lang.String newAttributeValueOperator2)
  

  A user can choose a search operators for attribute value operation. The value must be either 'LIKE'(for like operator) or 'EQUAL'(for equal operator).

  Parameters:

  newAttributeValueOperator2 - java.lang.String. The attribute value 2 operator, either 'LIKE' or 'EQUAL'.

• setAttributeValueOperator3

  public void setAttributeValueOperator3(java.lang.String newAttributeValueOperator3)
  

  A user can choose a search operators for attribute value operation. The value must be either 'LIKE'(for like operator) or 'EQUAL'(for equal operator).

  Parameters:

  newAttributeValueOperator3 - java.lang.String. The attribute value 3 operator, either 'LIKE' or 'EQUAL'.

• setAttributeValueOperator4

  public void setAttributeValueOperator4(java.lang.String newAttributeValueOperator4)
  

  A user can choose a search operators for attribute value operation. The value must be either 'LIKE'(for like operator) or 'EQUAL'(for equal operator).

  Parameters:

  newAttributeValueOperator4 - java.lang.String. The attribute value 4 operator, either 'LIKE' or 'EQUAL'.

• setAttributeValueOperator5

  public void setAttributeValueOperator5(java.lang.String newAttributeValueOperator5)
  

  A user can choose a search operators for attribute value operation. The value must be either 'LIKE'(for like operator) or 'EQUAL'(for equal operator).

  Parameters:

  newAttributeValueOperator5 - java.lang.String. The attribute value 5 operator, either 'LIKE' or 'EQUAL'.

• setAttributeValueOperator6

  public void setAttributeValueOperator6(java.lang.String newAttributeValueOperator6)
  

  A user can choose a search operators for attribute value operation. The value must be either 'LIKE'(for like operator) or 'EQUAL'(for equal operator).

  Parameters:

  newAttributeValueOperator6 - java.lang.String. The attribute value 6 operator, either 'LIKE' or 'EQUAL'.

• setAttributeValueOperator7

  public void setAttributeValueOperator7(java.lang.String newAttributeValueOperator7)
  

  A user can choose a search operators for attribute value operation. The value must be either 'LIKE'(for like operator) or 'EQUAL'(for equal operator).

  Parameters:

  newAttributeValueOperator7 - java.lang.String. The attribute value 7 operator, either 'LIKE' or 'EQUAL'.

• setAttributeValueOperator8

  public void setAttributeValueOperator8(java.lang.String newAttributeValueOperator8)
  

  A user can choose a search operators for attribute value operation. The value must be either 'LIKE'(for like operator) or 'EQUAL'(for equal operator).

  Parameters:

  newAttributeValueOperator8 - java.lang.String. The attribute value 8 operator, either 'LIKE' or 'EQUAL'.

• setAttributeValueOperator9

  public void setAttributeValueOperator9(java.lang.String newAttributeValueOperator9)
  

  A user can choose a search operators for attribute value operation. The value must be either 'LIKE'(for like operator) or 'EQUAL'(for equal operator).

  Parameters:

  newAttributeValueOperator9 - java.lang.String. The attribute value 9 operator, either 'LIKE' or 'EQUAL'.

• setAttributeValueType1

  public void setAttributeValueType1(java.lang.String newAttributeValueType1)
  

  The attribute value type can be one of three types STRING, INTEGER and FLOAT corresponding to columns StringValue, IntegerValue and FloatValue columns from AttrValue table.

  Parameters:

  newAttributeValueType1 - java.lang.String. The attribute value 1 type, either STRING, INTEGER or FLOAT.

• setAttributeValueType10

  public void setAttributeValueType10(java.lang.String newAttributeValueType10)
  

  The attribute value type can be one of three types STRING, INTEGER and FLOAT corresponding to columns StringValue, IntegerValue and FloatValue columns from AttrValue table.

  Parameters:

  newAttributeValueType10 - java.lang.String. The attribute value 10 type, either STRING, INTEGER or FLOAT.

• setAttributeValueType2

  public void setAttributeValueType2(java.lang.String newAttributeValueType2)
  

  The attribute value type can be one of three types STRING, INTEGER and FLOAT corresponding to columns StringValue, IntegerValue and FloatValue columns from AttrValue table.

  Parameters:

  newAttributeValueType2 - java.lang.String. The attribute value 2 type, either STRING, INTEGER or FLOAT.

• setAttributeValueType3

  public void setAttributeValueType3(java.lang.String newAttributeValueType3)
  

  The attribute value type can be one of three types STRING, INTEGER and FLOAT corresponding to columns StringValue, IntegerValue and FloatValue columns from AttrValue table.

  Parameters:

  newAttributeValueType3 - java.lang.String. The attribute value 3 type, either STRING, INTEGER or FLOAT.

• setAttributeValueType4

  public void setAttributeValueType4(java.lang.String newAttributeValueType4)
  

  The attribute value type can be one of three types STRING, INTEGER and FLOAT corresponding to columns StringValue, IntegerValue and FloatValue columns from AttrValue table.

  Parameters:

  newAttributeValueType4 - java.lang.String. The attribute value 4 type, either STRING, INTEGER or FLOAT.

• setAttributeValueType5

  public void setAttributeValueType5(java.lang.String newAttributeValueType5)
  

  The attribute value type can be one of three types STRING, INTEGER and FLOAT corresponding to columns StringValue, IntegerValue and FloatValue columns from AttrValue table.

  Parameters:

  newAttributeValueType5 - java.lang.String. The attribute value 5 type, either STRING, INTEGER or FLOAT.

• setAttributeValueType6

  public void setAttributeValueType6(java.lang.String newAttributeValueType6)
  

  The attribute value type can be one of three types STRING, INTEGER and FLOAT corresponding to columns StringValue, IntegerValue and FloatValue columns from AttrValue table.

  Parameters:

  newAttributeValueType6 - java.lang.String. The attribute value 6 type, either STRING, INTEGER or FLOAT.

• setAttributeValueType7

  public void setAttributeValueType7(java.lang.String newAttributeValueType7)
  

  The attribute value type can be one of three types STRING, INTEGER and FLOAT corresponding to columns StringValue, IntegerValue and FloatValue columns from AttrValue table.

  Parameters:

  newAttributeValueType7 - java.lang.String. The attribute value 7 type, either STRING, INTEGER or FLOAT.

• setAttributeValueType8

  public void setAttributeValueType8(java.lang.String newAttributeValueType8)
  

  The attribute value type can be one of three types STRING, INTEGER and FLOAT corresponding to columns StringValue, IntegerValue and FloatValue columns from AttrValue table.

  Parameters:

  newAttributeValueType8 - java.lang.String. The attribute value 8 type, either STRING, INTEGER or FLOAT.

• setAttributeValueType9

  public void setAttributeValueType9(java.lang.String newAttributeValueType9)
  

  The attribute value type can be one of three types STRING, INTEGER and FLOAT corresponding to columns StringValue, IntegerValue and FloatValue columns from AttrValue table.

  Parameters:

  newAttributeValueType9 - java.lang.String. The attribute value 9 type, either STRING, INTEGER or FLOAT.

• setCategoryTerm

  public void setCategoryTerm(java.lang.String newCategoryTerm)
  

  To set categoryTerm.

  Specified by:

  setCategoryTerm in interface com.ibm.commerce.search.beans.CatEntrySearchListInputDataBean

  Parameters:

  newCategoryTerm - java.lang.String. The category term used for the search.

• setCategoryTermCaseSensitive

  public void setCategoryTermCaseSensitive(java.lang.String newCategoryTermCaseSensitive)
  

  To set categoryTermCaseSensitive.

  Specified by:

  setCategoryTermCaseSensitive in interface com.ibm.commerce.search.beans.CatEntrySearchListInputDataBean

  Parameters:

  newCategoryTermCaseSensitive - java.lang.String. The category term case sensitive value used for the search.

• setCategoryTermOperator

  public void setCategoryTermOperator(java.lang.String newCategoryTermOperator)
  

  To set categoryTermOperator.

  Specified by:

  setCategoryTermOperator in interface com.ibm.commerce.search.beans.CatEntrySearchListInputDataBean

  Parameters:

  newCategoryTermOperator - java.lang.String. The category term operator used for the search.

• setCategoryTermScope

  public void setCategoryTermScope(java.lang.Integer newCategoryTermScope)
  

  Sets categoryTermScope 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). Case-insensitive search is not permitted on the long description column.

  Specified by:

  setCategoryTermScope in interface com.ibm.commerce.search.beans.CatEntrySearchListInputDataBean

  Parameters:

  newCategoryTermScope - The category term scope, either 1 (for name and short description), or 2 (for name only), or 3 (for name, short description and long description) or 4 (for keyword).

• setCategoryType

  public void setCategoryType(java.lang.String newCategoryType)
  

  To set categoryType.

  Specified by:

  setCategoryType in interface com.ibm.commerce.search.beans.CatEntrySearchListInputDataBean

  Parameters:

  newCategoryType - java.lang.String. The category type used for the search.

• setCatGroupId

  public void setCatGroupId(java.lang.String newCatGroupId)
  

  To set catGroupId. The category ID used by the search.

  Specified by:

  setCatGroupId in interface com.ibm.commerce.search.beans.CatEntrySearchListInputDataBean

  Parameters:

  newCatGroupId - java.lang.String. The catalog group ID.

• setCatGroupIdOperator

  public void setCatGroupIdOperator(java.lang.String newCatGroupIdOperator)
  

  To set catGroupIdOperator.

  Parameters:

  newCatGroupIdOperator - java.lang.String. The catalog group ID operator.

• setCatgrpSchemaType

  public void setCatgrpSchemaType(java.lang.String newCatgrpSchemaType)
  

  To set catgrpSchemaType.

  Parameters:

  newCatgrpSchemaType - java.lang.String. The catalog group schema type.

• setCoSearchSkuEnabled

  public void setCoSearchSkuEnabled(boolean newCoSearchSkuEnabled)
  

  To set coSearchSkuEnabled.

  Parameters:

  newCoSearchSkuEnabled - boolean. Co search sku enabled value, either true or false.

• setCurrency

  public void setCurrency(java.lang.String newCurrency)
  

  To set currency.

  Specified by:

  setCurrency in interface com.ibm.commerce.search.beans.CatEntrySearchListInputDataBean

  Parameters:

  newCurrency - java.lang.String. The currency used for the search.

• setCurrencyCaseSensitive

  public void setCurrencyCaseSensitive(java.lang.String newCurrencyCaseSensitive)
  

  To set currencyCaseSensitive.

  Specified by:

  setCurrencyCaseSensitive in interface com.ibm.commerce.search.beans.CatEntrySearchListInputDataBean

  Parameters:

  newCurrencyCaseSensitive - java.lang.String. The currency case sensitive value.

• setCurrencyOperator

  public void setCurrencyOperator(java.lang.String newCurrencyOperator)
  

  To set currencyOperator.

  Specified by:

  setCurrencyOperator in interface com.ibm.commerce.search.beans.CatEntrySearchListInputDataBean

  Parameters:

  newCurrencyOperator - java.lang.String. The currency operator.

• setDistinct

  public void setDistinct(java.lang.String newDistinct)
  

  To set distinct.

  Parameters:

  newDistinct - java.lang.String. The SQL distinct value used for the search.

• setFilterTerm

  public void setFilterTerm(java.lang.String newFilterTerm)
  

  Sets filterTerm. 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).

  Specified by:

  setFilterTerm in interface com.ibm.commerce.search.beans.CatEntrySearchListInputDataBean

  Parameters:

  newFilterTerm - java.lang.String. The filter term used for the search.

• setFilterTermCaseSensitive

  public void setFilterTermCaseSensitive(java.lang.String newFilterTermCaseSensitive)
  

  Sets filterTermCaseSensitive. 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).

  Specified by:

  setFilterTermCaseSensitive in interface com.ibm.commerce.search.beans.CatEntrySearchListInputDataBean

  Parameters:

  newFilterTermCaseSensitive - java.lang.String. The filter term case sensitive value used for the search.

• setFilterTermOperator

  public void setFilterTermOperator(java.lang.String newFilterTermOperator)
  

  Sets filterTermOperator. 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).

  Specified by:

  setFilterTermOperator in interface com.ibm.commerce.search.beans.CatEntrySearchListInputDataBean

  Parameters:

  newFilterTermOperator - java.lang.String. The filter term operator.

• setFilterType

  public void setFilterType(java.lang.String newFilterType)
  

  Sets filterType. 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).

  Specified by:

  setFilterType in interface com.ibm.commerce.search.beans.CatEntrySearchListInputDataBean

  Parameters:

  newFilterType - java.lang.Integer. The filter type.

• setIsAllNull

  public void setIsAllNull(boolean newIsAllNull)
  

  To set isAllNull.

  Parameters:

  newIsAllNull - boolean. The isALLNull flag.

• setIsBundle

  public void setIsBundle(boolean newIsBundle)
  

  To set isBundle.

  Parameters:

  newIsBundle - boolean. The isBundle flag.

• setIsDynamicKit

  public void setIsDynamicKit(boolean newIsDynamicKit)
  

  To set isDynamicKit.

  Parameters:

  newIsDynamicKit - boolean. The isDynamicKit flag.

• setIsItem

  public void setIsItem(boolean newIsItem)
  

  To set isItem.

  Parameters:

  newIsItem - boolean. The isItem flag.

• setIsPackage

  public void setIsPackage(boolean newIsPackage)
  

  To set isPackage.

  Parameters:

  newIsPackage - boolean. The isPackage flag.

• setIsProduct

  public void setIsProduct(boolean newIsProduct)
  

  To set isProduct.

  Parameters:

  newIsProduct - boolean. The isProduct flag.

• setExceededResultSize

  public void setExceededResultSize(boolean newExceeded)
  

  To set exceededResultSize.

  Parameters:

  newExceeded - boolean. The exceeded flag.

• setIsListPriceOn

  public void setIsListPriceOn(java.lang.String newIsListPriceOn)
  

  To set isListPriceOn.

  Specified by:

  setIsListPriceOn in interface com.ibm.commerce.search.beans.CatEntrySearchListInputDataBean

  Parameters:

  newIsListPriceOn - java.lang.String. The isListPriceOn flag.

• setLangId

  public void setLangId(java.lang.String newLangId)
  

  To set langId. The language ID used by the search.

  Parameters:

  newLangId - java.lang.String. The langauge ID used for the search.

• setManufacturer

  public void setManufacturer(java.lang.String newManufacturer)
  

  Sets manufacturer. manufacturer (String) : The value of this variable is used in search on a manufacturer's name (table columns searched: Catentry.Mfname).

  Specified by:

  setManufacturer in interface com.ibm.commerce.search.beans.CatEntrySearchListInputDataBean

  Parameters:

  newManufacturer - java.lang.String. The manufacturer used for the search.

• setManufacturerCaseSensitive

  public void setManufacturerCaseSensitive(java.lang.String newManufacturerCaseSensitive)
  

  Sets manufacturerCaseSensitive. 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).

  Specified by:

  setManufacturerCaseSensitive in interface com.ibm.commerce.search.beans.CatEntrySearchListInputDataBean

  Parameters:

  newManufacturerCaseSensitive - java.lang.String. The manufacturer case sensitive value.

• setManufacturerOperator

  public void setManufacturerOperator(java.lang.String newManufacturerOperator)
  

  Sets manufacturerOperator. 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).

  Specified by:

  setManufacturerOperator in interface com.ibm.commerce.search.beans.CatEntrySearchListInputDataBean

  Parameters:

  newManufacturerOperator - java.lang.String. The manufacturer operator used for the search.

• setManufacturerPartNum

  public void setManufacturerPartNum(java.lang.String newManufacturerPartNum)
  

  Sets manufacturerPartNum. manufacturerPartNum (String) :The value of this variable is used in search on a manufacturer's part number (table columns searched: Catentry.Mfpartnumber).

  Specified by:

  setManufacturerPartNum in interface com.ibm.commerce.search.beans.CatEntrySearchListInputDataBean

  Parameters:

  newManufacturerPartNum - java.lang.String. The manufacturer part number used for the search.

• setManufacturerPartNumCaseSensitive

  public void setManufacturerPartNumCaseSensitive(java.lang.String newManufacturerPartNumCaseSensitive)
  

  Sets manufacturerPartNumCaseSensitive. 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).

  Specified by:

  setManufacturerPartNumCaseSensitive in interface com.ibm.commerce.search.beans.CatEntrySearchListInputDataBean

  Parameters:

  newManufacturerPartNumCaseSensitive - java.lang.String. The manufacturer part number case sensitive value.

• setManufacturerPartNumOperator

  public void setManufacturerPartNumOperator(java.lang.String newManufacturerPartNumOperator)
  

  Sets manufacturerPartNumOperator. 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).

  Specified by:

  setManufacturerPartNumOperator in interface com.ibm.commerce.search.beans.CatEntrySearchListInputDataBean

  Parameters:

  newManufacturerPartNumOperator - java.lang.String. The manufacturer part number operator.

• setMaxPrice

  public void setMaxPrice(java.lang.String newMaxPrice)
  

  Sets maxPrice. maxPrice (String) : The values of this variable is used in search on price range (table columns searched: offerprice.currency, offerprice.price).

  Specified by:

  setMaxPrice in interface com.ibm.commerce.search.beans.CatEntrySearchListInputDataBean

  Parameters:

  newMaxPrice - java.lang.String. The maximum price value used for the search.

• setMinPrice

  public void setMinPrice(java.lang.String newMinPrice)
  

  Sets minPrice. minPrice (String) : The value of this variable is used in search on price range (table columns searched: offerprice.currency, offerprice.price).

  Specified by:

  setMinPrice in interface com.ibm.commerce.search.beans.CatEntrySearchListInputDataBean

  Parameters:

  newMinPrice - java.lang.String. The minimum price value used for the search.

• setOrderBy1

  public void setOrderBy1(java.lang.String newOrderBy1)
  

  Sets orderBy1. orderBy1 (String): Result set will be sorted by this attribute.

  Parameters:

  newOrderBy1 - java.lang.String. The order by 1 value.

• setOrderByOperator1

  public void setOrderByOperator1(java.lang.String newOrderByOperator1)
  

  Sets orderByOperator1. orderByOperator1 (String): Attributes can be sorted by ascending (default) or descending order. Allowed values are AscOperator and DescOperator

  Parameters:

  newOrderByOperator1 - java.lang.String. The order by 1 operator.

• setPredefinedAttributes

  protected void setPredefinedAttributes()
                                  throws java.lang.Exception
  

  Constructs search predicate using search interface.

  Specified by:

  setPredefinedAttributes in class SearchBaseDataBean

  Throws:

  java.lang.Exception