RuleQuery

java.lang.Object
- com.ibm.commerce.search.rulequery.RuleQuery

Direct Known Subclasses:

CustomQuery
```
public class RuleQuery
extends java.lang.Object
```
Search interface that is used to construct queries to search a catalog. The query will return catentry ids that match search criteria.
This class provides a set of methods where each method can used to construct a predicate (search criteria specified in WHERE clause of an SQL).
The search interface expects the predicates to be in post-fix format.
For example, the post-fix equivalent of A and B and C or D or E is ABC and D or E or where A, B, C, D and E are individual predicates.
Note the post-fix format is not strictly binary. For example, there can be more than two operands related to an operator.
Due to the flexibility of the postfix notation, it is the responsibility of the user to arrange the predicates and operators in the correct order to achieve the right query.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`AND_Operator` References the value used for the AND Operator
`static int`	`ANY_QueryType` References the value used for the ANY Query Type
`static int`	`ASC_Operator` References the value used for the ASC Operator
`static int`	`ATTRIBUTE_ATTRIBUTE_ID_Attr` References the value used for the ATTRIBUTE_ID column of the ATTRIBUTE database table
`static int`	`ATTRIBUTE_CATENTRY_ID_Attr` References the value used for the CATENTRY_ID column of the ATTRIBUTE database table
`static int`	`ATTRIBUTE_LANGUAGE_ID_Attr` References the value used for the LANGUAGE_ID column of the ATTRIBUTE database table
`static int`	`ATTRIBUTE_NAME_Attr` References the value used for the NAME column of the ATTRIBUTE database table
`static int`	`ATTRVALUE_ATTRIBUTE_ID_Attr` References the value used for the ATTRIBUTE_ID column of the ATTRVALUE database table
`static int`	`ATTRVALUE_CATENTRY_ID_Attr` References the value used for the CATENTRY_ID column of the ATTRVALUE database table
`static int`	`ATTRVALUE_FLOATVALUE_Attr` References the value used for the FLOATVALUE column of the ATTRVALUE database table
`static int`	`ATTRVALUE_INTEGERVALUE_Attr` References the value used for the INTEGERVALUE column of the ATTRVALUE database table
`static int`	`ATTRVALUE_LANGUAGE_ID_Attr` References the value used for the LANGUAGE_ID column of the ATTRVALUE database table
`static int`	`ATTRVALUE_NAME_Attr` References the value used for the NAME column of the ATTRVALUE database table
`static int`	`ATTRVALUE_STRINGVALUE_Attr` References the value used for the STRINGVALUE column of the ATTRVALUE database table
`static int`	`AVG_Operator` References the value used for the AVG Operator
`static int`	`BOTH_QueryType` References the value used for the BOTH Query Type
`static int`	`BUNDLE_CatEntryType` References the value used for the BUNDLE CatEntry Type
`static int`	`CATALOG_CATALOG_ID_Attr` References the value used for the CATALOG_ID column of the CATALOG database table
`static int`	`CATALOG_DESCRIPTION_Attr` References the value used for the DESCRIPTION column of the CATALOG database table
`static int`	`CATALOG_IDENTIFIER_Attr` References the value used for the IDENTIFIER column of the CATALOG database table
`static int`	`CATALOGDSC_LANGUAGE_ID_Attr` References the value used for the LANGUAGE_ID column of the CATALOGDSC database table
`static int`	`CATALOGDSC_NAME_Attr` References the value used for the NAME column of the CATALOGDSC database table
`static int`	`CATALOGDSC_SHORTDESCRIPTION_Attr` References the value used for the SHORTDESCRIPTION column of the CATALOGDSC database table
`static int`	`CATENTDESC_AVAILABILITY_DATE_Attr` References the value used for the AVAILABILITY_DATE column of the CATENTDESC database table
`static int`	`CATENTDESC_AVAILABLE_Attr` References the value used for the AVAILABLE column of the CATENTDESC database table
`static int`	`CATENTDESC_CATENTRY_ID_Attr` References the value used for the CATENTRY_ID column of the CATENTDESC database table
`static int`	`CATENTDESC_KEYWORD_Attr` References the value used for the KEYWORD column of the CATENTDESC database table
`static int`	`CATENTDESC_LANGUAGE_ID_Attr` References the value used for the LANGUAGE_ID column of the CATENTDESC database table
`static int`	`CATENTDESC_LONGDESCRIPTION_Attr` References the value used for the LONGDESCRIPTION column of the CATENTDESC database table
`static int`	`CATENTDESC_NAME_Attr` References the value used for the NAME column of the CATENTDESC database table
`static int`	`CATENTDESC_PARTNUMBER_Attr` References the value used for the PARTNUMBER column of the CATENTDESC database table
`static int`	`CATENTDESC_PUBLISHED_Attr` References the value used for the PUBLISHED column of the CATENTDESC database table
`static int`	`CATENTDESC_SHORT_DESC_Attr` References the value used for the SHORT_DESC column of the CATENTDESC database table
`static int`	`CATENTDESC_SHORTDESCRIPTION_Attr` References the value used for the SHORTDESCRIPTION column of the CATENTDESC database table
`static int`	`CATENTDESC_THUMBNAIL_Attr` References the value used for the THUMBNAIL column of the CATENTDESC database table
`static int`	`CATENTREL_CATENTRY_ID_CHILD_Attr` References the value used for the CATENTRY_ID_CHILD column of the CATENTREL database table
`static int`	`CATENTREL_CATENTRY_ID_PARENT_Attr` References the value used for the CATENTRY_ID_PARENT column of the CATENTREL database table
`static int`	`CATENTREL_CATREL_TYPE_ID_Attr` References the value used for the CATREL_TYPE_ID column of the CATENTREL database table
`static int`	`CATENTRY_BUYABLE_Attr` References the value used for the BUYABLE column of the CATENTRY database table
`static int`	`CATENTRY_CATENTRY_ID_Attr` References the value used for the CATENTRY_ID column of the CATENTRY database table
`static int`	`CATENTRY_CATENTTYPE_ID_Attr` References the value used for the CATENTTYPE_ID column of the CATENTRY database table
`static int`	`CATENTRY_FIELD1_Attr` This field corresponds to the field1 column attribute of `catentry` table
`static int`	`CATENTRY_FIELD2_Attr` This field corresponds to the field2 column attribute of `catentry` table
`static int`	`CATENTRY_FIELD3_Attr` This field corresponds to the field3 column attribute of `catentry` table
`static int`	`CATENTRY_FIELD4_Attr` This field corresponds to the field4 column attribute of `catentry` table
`static int`	`CATENTRY_FIELD5_Attr` This field corresponds to the field5 column attribute of `catentry` table
`static int`	`CATENTRY_ID_Attr` References the value used for the CATENTRY_ID column
`static int`	`CATENTRY_LASTUPDATE_Attr` References the value used for the LASTUPDATE column of the CATENTRY database table
`static int`	`CATENTRY_MARKFORDELETE_Attr` References the value used for the MARKFORDELETE column of the CATENTRY database table
`static int`	`CATENTRY_MFNAME_Attr` References the value used for the MFNAME column of the CATENTRY database table
`static int`	`CATENTRY_MFPARTNUMBER_Attr` References the value used for the MFPARTNUMBER column of the CATENTRY database table
`static int`	`CATENTRY_ONAUCTION_Attr` References the value used for the ONAUCTION column of the CATENTRY database table
`static int`	`CATENTRY_ONSPECIAL_Attr` References the value used for the ONSPECIAL column of the CATENTRY database table
`static int`	`CATENTRY_PARTNUMBER_Attr` References the value used for the PARTNUMBER column of the CATENTRY database table
`static int`	`CATENTRY_SKU_Attr` References the value used for the SKU column of the CATENTRY database table
`static int`	`CATENTRY_SKU_QueryType` References the value used for the CATENTRY_SKU function
`static int`	`CATGPENREL_CATALOG_ID_Attr` References the value used for the CATALOG_ID column of the CATGPENREL database table
`static int`	`CATGPENREL_CATENTRY_ID_Attr` References the value used for the CATENTRY_ID column of the CATGPENREL database table
`static int`	`CATGPENREL_CATGROUP_ID_Attr` References the value used for the CATGROUP_ID column of the CATGPENREL database table
`static int`	`CATGROUP_CATGROUP_ID_Attr` References the value used for the CATGROUP_ID column of the CATGROUP database table
`static int`	`CATGROUP_IDENTIFIER_Attr` References the value used for the IDENTIFIER column of the CATGROUP database table
`static int`	`CATGROUP_IDENTIFIER_ID_Attr` References the value used for the IDENTIFIER_ID column of the CATGROUP database table
`static int`	`CATGROUP_LASTUPDATE_Attr` References the value used for the LASTUPDATE column of the CATGROUP database table
`static int`	`CATGROUP_MARKFORDELETE_Attr` References the value used for the MARKFORDELETE column of the CATGROUP database table
`static int`	`CATGRPDESC_KEYWORD_Attr` References the value used for the KEYWORD column of the CATGRPDESC database table
`static int`	`CATGRPDESC_LANGUAGE_ID_Attr` References the value used for the LANGUAGE_ID column of the CATGRPDESC database table
`static int`	`CATGRPDESC_LONGDESCRIPTION_Attr` References the value used for the LONGDESCRIPTION column of the CATGRPDESC database table
`static int`	`CATGRPDESC_NAME_Attr` References the value used for the NAME column of the CATGRPDESC database table
`static int`	`CATGRPDESC_PUBLISHED_Attr` References the value used for the PUBLISHED column of the CATGRPDESC database table
`static int`	`CATGRPDESC_SHORTDESCRIPTION_Attr` References the value used for the SHORTDESCRIPTION column of the CATGRPDESC database table
`static java.lang.String`	`COPYRIGHT` Copyright
`static int`	`COUNT_Operator` References the value used for the COUNT Operator
`boolean`	`defaultResultSelection` The default result selection boolean value
`static int`	`DESC_Operator` References the value used for the DESC Operator
`static int`	`DYNAMICKIT_CatEntryType` References the value used for the DYNAMICKIT CatEntry Type
`static int`	`EQ_Operator` References the value used for the EQ Operator
`static int`	`GE_Operator` References the value used for the GE Operator
`static int`	`GENERIC_QueryType` References the value used for the GENERIC Query Type
`static int`	`GROUP_BY_Operator` References the value used for the GROUP_BY Operator
`static int`	`GT_Operator` References the value used for the GT Operator
`static int`	`IN_Operator` References the value used for the IN Operator
`static int`	`INVSTVW_QUANTITY_AVAILABLE_Attr` References the value used for the QUANTITY_AVAILABLE column of the INVSTVW database table
`static int`	`INVSTVW_QUANTITY_MEASURE_Attr` References the value used for the QUANTITY_MEASURE column of the INVSTVW database table
`static int`	`INVSTVW_STORE_ID_Attr` References the value used for the STORE_ID column of the INVSTVW database table
`static int`	`IS_NOT_NULL_Operator` References the value used for the IS_NOT_NULL Operator
`static int`	`IS_NULL_Operator` References the value used for the IS_NULL Operator
`boolean`	`isAll` The boolean value representing the isAll attribute
`boolean`	`isBundle` The boolean value representing the isBundle attribute
`boolean`	`isDynamicKit` The boolean value representing the isDynamicKit attribute
`boolean`	`isItem` The boolean value representing the isItem attribute
`boolean`	`isPackage` The boolean value representing the isPackage attribute
`boolean`	`isProduct` The boolean value representing the isProduct attribute
`static int`	`ITEM_CatEntryType` References the value used for the ITEM CatEntry Type
`static int`	`ITEM_QueryType` References the value used for the ITEM Query Type
`static int`	`LE_Operator` References the value used for the LE Operator
`static int`	`LEFT_LIKE_Operator` References the value used for the LEFT_LIKE Operator
`static int`	`LIKE_Operator` References the value used for the LIKE Operator
`static int`	`LISTPRICE_Attr` References the value used for the LISTPRICE column
`static int`	`LISTPRICE_CATENTRY_ID_Attr` References the value used for the CATENTRY_ID column of the LISTPRICE database table
`static int`	`LISTPRICE_CURRENCY_Attr` References the value used for the CURRENCY column of the LISTPRICE database table
`static int`	`LISTPRICE_LISTPRICE_Attr` References the value used for the LISTPRICE column of the Listprice database table
`static int`	`LT_Operator` References the value used for the LT Operator
`static int`	`MAX_Operator` References the value used for the MAX Operator
`static int`	`MIN_Operator` References the value used for the MIN Operator
`static int`	`NE_Operator` References the value used for the NE Operator
`static int`	`NOT_GT_Operator` References the value used for the NOT_GT Operator
`static int`	`NOT_IN_Operator` References the value used for the NOT_IN Operator
`static int`	`NOT_LEFT_LIKE_Operator` References the value used for the NOT_LEFT_LIKE Operator
`static int`	`NOT_LIKE_Operator` References the value used for the NOT_LIKE Operator
`static int`	`NOT_LT_Operator` References the value used for the NOT_LT Operator
`static int`	`NOT_RIGHT_LIKE_Operator` References the value used for the NOT_RIGHT_LIKE Operator
`static int`	`OFFER_MAXIMUMQUANTITY_Attr` References the value used for the MAXIMUMQUANTITY column of the OFFER database table
`static int`	`OFFER_MINIMUMQUANTITY_Attr` References the value used for the MINIMUMQUANTITY column of the OFFER database table
`static int`	`OFFER_OFFER_ID_Attr` References the value used for the OFFER_ID column of the OFFER database table
`static int`	`OFFER_TRADEPOSCN_ID_Attr` References the value used for the TRADEPOSCN_ID column of the OFFER database table
`static int`	`OFFERPRICE_CURRENCY_Attr` References the value used for the CURRENCY column of the CATEOFFERPRICE NTDESC database table
`static int`	`OFFERPRICE_OFFER_ID_Attr` References the value used for the OFFER_ID column of the CATEOFFERPRICE NTDESC database table
`static int`	`OFFERPRICE_PRICE_Attr` References the value used for the PRICE column of the OFFERPRICE database table
`static int`	`OR_Operator` References the value used for the OR Operator
`static int`	`ORDER_BY_Operator` References the value used for the ORDER_BY Operator
`static int`	`PACKAGE_CatEntryType` References the value used for the PACKAGE CatEntry Type
`static int`	`PRODUCT_CatEntryType` References the value used for the PRODUCT CatEntry Type
`static int`	`PRSETCEREL_CATENTRY_ID_Attr` References the value used for the CATENTRY_ID column of the PRSETCEREL database table
`static int`	`PRSETCEREL_PRODUCTSET_ID_Attr` References the value used for the PRODUCTSET_ID column of the PRSETCEREL database table
`static int`	`RIGHT_LIKE_Operator` References the value used for the RIGHT_LIKE Operator
`static int`	`STDPRICEVW_CATENTRY_ID_Attr` References the value used for the CATENTRY_ID column of the STDPRICEVW database table
`static int`	`STDPRICEVW_CURRENCY_Attr` References the value used for the CURRENCY column of the STDPRICEVW database table
`static int`	`STDPRICEVW_PRICE_Attr` References the value used for the PRICE column of the STDPRICEVW database table
`static int`	`STORECAT_MASTERCATALOG_Attr` References the value used for the MASTERCATALOG column of the STORECAT database table
`static int`	`STORECAT_STOREENT_ID_Attr` References the value used for the STOREENT_ID column of the STORECAT database table
`static int`	`STORECATENTRY_STORE_ID_Attr` References the value used for the STORE_ID column of the STORECATENTRY database table
`static int`	`STORECGRP_STOREENT_ID_Attr` References the value used for the STOREENT_ID column of the STORECGRP database table
`static int`	`STOREINVENTORY_QUANTITY_Attr` References the value used for the QUANTITY column of the STOREINVENTORY database table
`static int`	`STOREINVENTORY_QUANTITY_MEASURE_Attr` References the value used for the QUANTITYMEASURE column of the STOREINVENTORY database table
`static int`	`SUM_Operator` References the value used for the SUM Operator
`static int`	`TRADEPOSCN_TRADEPOSCN_ID_Attr` References the value used for the TRADEPOSCN_ID column of the TRADEPOSCN database table
`static int`	`TRADEPOSCN_TYPE_ID_Attr` References the value used for the TYPE_ID column of the TRADEPOSCN database table
`static int`	`UPPER_Function` References the value used for the UPPER function
`static int`	`USER_ID_Attr` References the value used for the USER_ID attribute.

Constructor Summary

Constructors
Constructor and Description
`RuleQuery()` RuleQuery constructor with no arguments.
`RuleQuery(int inStoreID, int inUserID)` Rule query constructor with store and user id as arguments.
`RuleQuery(int inStoreID, TradingAgreementAccessBean[] agreements)` Deprecated. Replaced by `RuleQuery(int inStoreID, TradingAgreementAccessBean[] agreements, Long userId)`.
`RuleQuery(int inStoreID, TradingAgreementAccessBean[] agreements, java.lang.Long userId)` RuleQuery constructor with store id, Trading agreement access bean and user id as arguments.
`RuleQuery(com.ibm.commerce.search.base.Query q)` RuleQuery constructor with Query as argument.
`RuleQuery(TradingAgreementAccessBean[] agreements)` Deprecated. Replaced by `RuleQuery(TradingAgreementAccessBean[] agreements, Long userId)`.
`RuleQuery(TradingAgreementAccessBean[] agreements, java.lang.Long userId)` RuleQuery constructor with Trading Agreement Access bean and user id as arguments.
`RuleQuery(java.util.Vector inStoreIDs, int inUserID)` Rule query constructor with multiple store id and single user id as arguments.
`RuleQuery(java.util.Vector inStoreIDs, TradingAgreementAccessBean[] agreements)` Deprecated. Replaced by `RuleQuery(Vector inStoreIDs, TradingAgreementAccessBean[] agreements, Long userId)`.
`RuleQuery(java.util.Vector inStoreIDs, TradingAgreementAccessBean[] agreements, java.lang.Long userId)` RuleQuery constructor with multiple store id, Trading agreement access bean and user id as arguments.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addFilterAttribute(int attribute, int operator)` Adds a predicate to query Where clause to filter a row, example, TABLE.COLUMN IS NOT NULL.
`void`	`addFilterAttribute(int attribute, int operator, int function)` Adds a predicate to query Where clause to filter a row, example FUNCTION(TABLE.COLUMN) IS NULL.
`void`	`addFilterAttribute(int attribute, int operator, java.lang.String value)` Adds a predicate to query Where clause to filter a row, example, TABLE.COLUMN LIKE '%VALUE%'.
`void`	`addFilterAttribute(int attribute, int operator, java.lang.String value, int function)` Adds a predicate to query Where clause to filter a row, example FUNCTION(TABLE.COLUMN) LIKE '%VALUE%'.
`void`	`addFilterOperand(com.ibm.commerce.search.base.Attribute attr)` Adds a WHERE clause predicate into temporary filter predicate collection.
`void`	`addFilterOperand(com.ibm.commerce.search.base.Predicate predicate)` Adds a collection of WHERE clause predicates into temporary filter predicate collection.
`void`	`addFilterOperator(int operator)` Adds an operator that combines a set of filter predicates.
`void`	`addGlobalPredicate(com.ibm.commerce.search.base.Predicate globalPredicate)` Method to insert a predicate that will be applied to entire query like BUYABLE/PUBLISHABLE/LANGUAGE_ID.
`void`	`addGroupByAttribute(int attribute)` To set group by operator The attribute parameter values are obtained from the corresponding constants defined within this class.
`void`	`addGroupByAttribute(java.lang.String attribute)` To set group by operator.
`void`	`addOrderByAttribute(int attribute, int operator)` To set order by operator The attribute and operator parameter values are obtained from the corresponding constants defined within this class.
`void`	`addOrderByAttribute(java.lang.String attribute, java.lang.String operator)` To set order by operator
`void`	`addOrderByAttribute1(int attribute, int operator)` To set order by operator The attribute and operator parameter values are obtained from the corresponding constants defined within this class.
`void`	`addResultAttribute(int resultAttribute)` To add valid result set.
`void`	`addResultAttribute(java.lang.String attribute)` To add valid result set.
`void`	`addResultAttribute(java.lang.String attribute, java.lang.String operator)` To add valid result set.
`void`	`addRule()` Adds a set of predicates to a Query.
`void`	`addRule(int aQueryType)` Deprecated. Replaced by `addRule()`.
`void`	`addSelectAttribute(int attribute, int operator)` Adds a predicate to query Where clause, example, TABLE.COLUMN IS NOT NULL.
`void`	`addSelectAttribute(int attribute, int operator, int function)` Adds a predicate to query Where clause, example FUNCTION(TABLE.COLUMN) IS NULL.
`void`	`addSelectAttribute(int attribute, int operator, java.lang.String value)` Adds a predicate to query Where clause, example, TABLE.COLUMN LIKE '%VALUE%'.
`void`	`addSelectAttribute(int attribute, int operator, java.lang.String value, int function)` Adds a predicate to query Where clause, example FUNCTION(TABLE.COLUMN) LIKE '%VALUE%'.
`void`	`addSelectAttribute(java.lang.String attribute, int operator, java.lang.String value)` Deprecated. Replaced by `addSelectAttribute(int attribute, int operator, String value)`.
`void`	`addSelectAttribute(java.lang.String attribute, int operator, java.lang.String value, int attrValueType, java.lang.String languageId, java.lang.String prodType)` Adds a Rich attribute predicate.
`void`	`addSelectAttribute(java.lang.String attribute, int operator, java.lang.String value, int attrValueType, java.lang.String languageId, java.lang.String prodType, int function)` Adds a Rich attribute predicate.
`void`	`addSelectAttribute(java.lang.String attribute, int operator, java.lang.String value, java.lang.String languageId, java.lang.String prodType)` Deprecated. Replaced by `addSelectAttribute(String attribute, int operator, String value, int attrValueType, String languageId, String prodType, int function)`.
`void`	`addSelectAttribute(java.lang.String attribute, int operator, java.lang.String value, java.lang.String languageId, java.lang.String prodType, int function)` Deprecated. Replaced by `addSelectAttribute(String attribute, int operator, String value, int attrValueType, String languageId, String prodType, int function)`.
`void`	`addSelectOperand(com.ibm.commerce.search.base.Attribute attr)` Adds a WHERE clause predicate into temporary select set predicate collection.
`void`	`addSelectOperand(com.ibm.commerce.search.base.Predicate predicate)` Adds a collection of WHERE clause predicates into temporary select set predicate collection.
`void`	`addSelectOperator(int operator)` Adds an operator that combines a set of filter predicates.
`java.util.Vector`	`execute()` Executes catalog search query and retrieves all the `catentry` ids that satisfy the query.
`java.util.Vector`	`execute(com.ibm.commerce.base.objects.Cursor aCursor)` Executes catalog search query and retrieves a set of `catentry` id between a start value and end value specified in the cursor object.
`com.ibm.commerce.dynacache.commands.CachedCollectionEnumeration`	`execute(int aInitialIndex, com.ibm.commerce.dynacache.commands.AbstractDistributedMapCache aDistributedMapCache)` Gets a cached result or executes a catalog search query to retrieves an enumeration of `catentry` id.
`java.util.Vector`	`findStorePaths(int sid)` This method can be used to find store paths for a store id
`java.lang.Integer`	`getCatgrpSchemaType()` Returns the `catgroup` schema type.
`java.util.Locale`	`getLocale()` gets the locale used in the query.
`java.lang.Long`	`getLongUserId()` Returns the user id of type Long.
`com.ibm.commerce.search.base.Query`	`getMcQuery()` Returns the query object.
`com.ibm.commerce.search.base.Predicate`	`getOptCatgrpPredicate()` Gets the `Predicate` optCatgrpPredicate to be used in the query.
`com.ibm.commerce.search.base.Predicate`	`getPredicate()` Returns the selectSet and filterSet predicate.
`int`	`getQueryType()` Returns the query type.
`java.lang.Integer`	`getRASchemaType()` Returns RASchemaType.
`java.util.Vector`	`getResultSet()` Returns the query result set.
`int`	`getSelectivitySize()` Returns the selectivity size.
`java.util.Vector`	`getSourceTables()` Returns the tables used in the query from clause.
`java.lang.Integer`	`getStoreID()` Returns the store id.
`java.util.Vector`	`getStoreIDs()` Returns the collection of store id.
`java.lang.Integer`	`getUserID()` Returns the user id of type integer.
`void`	`initialize()` Initialize dictionary containing meta-data for attribute information
`boolean`	`isPriceSummary()` Returns if there is summary table for price or not
`void`	`reset()` Re-initialize filterSet and selectSet variables
`void`	`resetQueryType()` Method to reset queryType to override default.
`void`	`setAgreements(TradingAgreementAccessBean[] newAgreements)` To set trading agreements.
`void`	`setCatgrpSchemaType(java.lang.Integer newCatgrpSchemaType)` To set catgrpSchemaType.
`void`	`setDefaultResultSelection()` To set default result selection variable.
`void`	`setDistinct()` To set distinct operator
`void`	`setDistinct(boolean distinctFlag)` To set distinct operator.
`void`	`setLocale(java.util.Locale locale)` sets the locale used in the query.
`void`	`setLongUserId(java.lang.Long newLongUserId)` Deprecated. Replaced by `RuleQuery(TradingAgreementAccessBean[] agreements, Long userId)`, `RuleQuery(int inStoreID, TradingAgreementAccessBean[] agreements, Long userId)`, `RuleQuery(int inStoreID, int inUserID)`.
`void`	`setOptCatgrpPredicate(com.ibm.commerce.search.base.Predicate anOptCatgrpPredicate)` Sets the `Predicate` optCatgrpPredicate to be used in the query.
`void`	`setRASchemaType(java.lang.Integer newRASchemaType)` To set the schema type.
`void`	`setSelectivitySize(int newSelectivitySize)` Set selectivity size
`void`	`setStoreID(java.lang.Integer newStoreID)` Set store id.
`void`	`setStoreIDs(java.util.Vector newStoreIDs)` Set collection of store ids
`void`	`setUserID(int newUserID)` Deprecated. Replaced by `RuleQuery(TradingAgreementAccessBean[] agreements, Long userId)`, `RuleQuery(int inStoreID, TradingAgreementAccessBean[] agreements, Long userId)`, `RuleQuery(int inStoreID, int inUserID)`.
`java.lang.String`	`toString()` Returns query string

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - COPYRIGHT
```
public static final java.lang.String COPYRIGHT
```
    Copyright
    
    See Also:
    
    Constant Field Values
  - LISTPRICE_LISTPRICE_Attr
```
public static final int LISTPRICE_LISTPRICE_Attr
```
    References the value used for the LISTPRICE column of the Listprice database table
    
    See Also:
    
    Constant Field Values
  - LISTPRICE_Attr
```
public static final int LISTPRICE_Attr
```
    References the value used for the LISTPRICE column
    
    See Also:
    
    Constant Field Values
  - LISTPRICE_CURRENCY_Attr
```
public static final int LISTPRICE_CURRENCY_Attr
```
    References the value used for the CURRENCY column of the LISTPRICE database table
    
    See Also:
    
    Constant Field Values
  - LISTPRICE_CATENTRY_ID_Attr
```
public static final int LISTPRICE_CATENTRY_ID_Attr
```
    References the value used for the CATENTRY_ID column of the LISTPRICE database table
    
    See Also:
    
    Constant Field Values
  - STOREINVENTORY_QUANTITY_Attr
```
public static final int STOREINVENTORY_QUANTITY_Attr
```
    References the value used for the QUANTITY column of the STOREINVENTORY database table
    
    See Also:
    
    Constant Field Values
  - STOREINVENTORY_QUANTITY_MEASURE_Attr
```
public static final int STOREINVENTORY_QUANTITY_MEASURE_Attr
```
    References the value used for the QUANTITYMEASURE column of the STOREINVENTORY database table
    
    See Also:
    
    Constant Field Values
  - CATGRPDESC_NAME_Attr
```
public static final int CATGRPDESC_NAME_Attr
```
    References the value used for the NAME column of the CATGRPDESC database table
    
    See Also:
    
    Constant Field Values
  - CATGRPDESC_LANGUAGE_ID_Attr
```
public static final int CATGRPDESC_LANGUAGE_ID_Attr
```
    References the value used for the LANGUAGE_ID column of the CATGRPDESC database table
    
    See Also:
    
    Constant Field Values
  - CATGRPDESC_LONGDESCRIPTION_Attr
```
public static final int CATGRPDESC_LONGDESCRIPTION_Attr
```
    References the value used for the LONGDESCRIPTION column of the CATGRPDESC database table
    
    See Also:
    
    Constant Field Values
  - CATGRPDESC_SHORTDESCRIPTION_Attr
```
public static final int CATGRPDESC_SHORTDESCRIPTION_Attr
```
    References the value used for the SHORTDESCRIPTION column of the CATGRPDESC database table
    
    See Also:
    
    Constant Field Values
  - CATGRPDESC_KEYWORD_Attr
```
public static final int CATGRPDESC_KEYWORD_Attr
```
    References the value used for the KEYWORD column of the CATGRPDESC database table
    
    See Also:
    
    Constant Field Values
  - CATGRPDESC_PUBLISHED_Attr
```
public static final int CATGRPDESC_PUBLISHED_Attr
```
    References the value used for the PUBLISHED column of the CATGRPDESC database table
    
    See Also:
    
    Constant Field Values
  - CATENTRY_SKU_Attr
```
public static final int CATENTRY_SKU_Attr
```
    References the value used for the SKU column of the CATENTRY database table
    
    See Also:
    
    Constant Field Values
  - CATENTRY_CATENTRY_ID_Attr
```
public static final int CATENTRY_CATENTRY_ID_Attr
```
    References the value used for the CATENTRY_ID column of the CATENTRY database table
    
    See Also:
    
    Constant Field Values
  - CATENTRY_ID_Attr
```
public static final int CATENTRY_ID_Attr
```
    References the value used for the CATENTRY_ID column
    
    See Also:
    
    Constant Field Values
  - CATENTRY_BUYABLE_Attr
```
public static final int CATENTRY_BUYABLE_Attr
```
    References the value used for the BUYABLE column of the CATENTRY database table
    
    See Also:
    
    Constant Field Values
  - CATENTRY_ONAUCTION_Attr
```
public static final int CATENTRY_ONAUCTION_Attr
```
    References the value used for the ONAUCTION column of the CATENTRY database table
    
    See Also:
    
    Constant Field Values
  - CATENTRY_ONSPECIAL_Attr
```
public static final int CATENTRY_ONSPECIAL_Attr
```
    References the value used for the ONSPECIAL column of the CATENTRY database table
    
    See Also:
    
    Constant Field Values
  - CATENTRY_PARTNUMBER_Attr
```
public static final int CATENTRY_PARTNUMBER_Attr
```
    References the value used for the PARTNUMBER column of the CATENTRY database table
    
    See Also:
    
    Constant Field Values
  - CATENTRY_MFNAME_Attr
```
public static final int CATENTRY_MFNAME_Attr
```
    References the value used for the MFNAME column of the CATENTRY database table
    
    See Also:
    
    Constant Field Values
  - CATENTRY_MFPARTNUMBER_Attr
```
public static final int CATENTRY_MFPARTNUMBER_Attr
```
    References the value used for the MFPARTNUMBER column of the CATENTRY database table
    
    See Also:
    
    Constant Field Values
  - CATENTRY_MARKFORDELETE_Attr
```
public static final int CATENTRY_MARKFORDELETE_Attr
```
    References the value used for the MARKFORDELETE column of the CATENTRY database table
    
    See Also:
    
    Constant Field Values
  - CATENTRY_LASTUPDATE_Attr
```
public static final int CATENTRY_LASTUPDATE_Attr
```
    References the value used for the LASTUPDATE column of the CATENTRY database table
    
    See Also:
    
    Constant Field Values
  - CATENTRY_CATENTTYPE_ID_Attr
```
public static final int CATENTRY_CATENTTYPE_ID_Attr
```
    References the value used for the CATENTTYPE_ID column of the CATENTRY database table
    
    See Also:
    
    Constant Field Values
  - CATENTRY_FIELD4_Attr
```
public static final int CATENTRY_FIELD4_Attr
```
    This field corresponds to the field4 column attribute of catentry table
    
    See Also:
    
    Constant Field Values
  - CATENTRY_FIELD1_Attr
```
public static final int CATENTRY_FIELD1_Attr
```
    This field corresponds to the field1 column attribute of catentry table
    
    See Also:
    
    Constant Field Values
  - CATENTRY_FIELD2_Attr
```
public static final int CATENTRY_FIELD2_Attr
```
    This field corresponds to the field2 column attribute of catentry table
    
    See Also:
    
    Constant Field Values
  - CATENTRY_FIELD3_Attr
```
public static final int CATENTRY_FIELD3_Attr
```
    This field corresponds to the field3 column attribute of catentry table
    
    See Also:
    
    Constant Field Values
  - CATENTRY_FIELD5_Attr
```
public static final int CATENTRY_FIELD5_Attr
```
    This field corresponds to the field5 column attribute of catentry table
    
    See Also:
    
    Constant Field Values
  - CATENTDESC_NAME_Attr
```
public static final int CATENTDESC_NAME_Attr
```
    References the value used for the NAME column of the CATENTDESC database table
    
    See Also:
    
    Constant Field Values
  - CATENTDESC_AVAILABILITY_DATE_Attr
```
public static final int CATENTDESC_AVAILABILITY_DATE_Attr
```
    References the value used for the AVAILABILITY_DATE column of the CATENTDESC database table
    
    See Also:
    
    Constant Field Values
  - CATENTDESC_LANGUAGE_ID_Attr
```
public static final int CATENTDESC_LANGUAGE_ID_Attr
```
    References the value used for the LANGUAGE_ID column of the CATENTDESC database table
    
    See Also:
    
    Constant Field Values
  - CATENTDESC_PUBLISHED_Attr
```
public static final int CATENTDESC_PUBLISHED_Attr
```
    References the value used for the PUBLISHED column of the CATENTDESC database table
    
    See Also:
    
    Constant Field Values
  - CATENTDESC_SHORT_DESC_Attr
```
public static final int CATENTDESC_SHORT_DESC_Attr
```
    References the value used for the SHORT_DESC column of the CATENTDESC database table
    
    See Also:
    
    Constant Field Values
  - CATENTDESC_CATENTRY_ID_Attr
```
public static final int CATENTDESC_CATENTRY_ID_Attr
```
    References the value used for the CATENTRY_ID column of the CATENTDESC database table
    
    See Also:
    
    Constant Field Values
  - CATENTDESC_THUMBNAIL_Attr
```
public static final int CATENTDESC_THUMBNAIL_Attr
```
    References the value used for the THUMBNAIL column of the CATENTDESC database table
    
    See Also:
    
    Constant Field Values
  - CATENTDESC_LONGDESCRIPTION_Attr
```
public static final int CATENTDESC_LONGDESCRIPTION_Attr
```
    References the value used for the LONGDESCRIPTION column of the CATENTDESC database table
    
    See Also:
    
    Constant Field Values
  - CATENTDESC_SHORTDESCRIPTION_Attr
```
public static final int CATENTDESC_SHORTDESCRIPTION_Attr
```
    References the value used for the SHORTDESCRIPTION column of the CATENTDESC database table
    
    See Also:
    
    Constant Field Values
  - CATENTDESC_PARTNUMBER_Attr
```
public static final int CATENTDESC_PARTNUMBER_Attr
```
    References the value used for the PARTNUMBER column of the CATENTDESC database table
    
    See Also:
    
    Constant Field Values
  - CATENTDESC_KEYWORD_Attr
```
public static final int CATENTDESC_KEYWORD_Attr
```
    References the value used for the KEYWORD column of the CATENTDESC database table
    
    See Also:
    
    Constant Field Values
  - CATENTDESC_AVAILABLE_Attr
```
public static final int CATENTDESC_AVAILABLE_Attr
```
    References the value used for the AVAILABLE column of the CATENTDESC database table
    
    See Also:
    
    Constant Field Values
  - STORECATENTRY_STORE_ID_Attr
```
public static final int STORECATENTRY_STORE_ID_Attr
```
    References the value used for the STORE_ID column of the STORECATENTRY database table
    
    See Also:
    
    Constant Field Values
  - USER_ID_Attr
```
public static final int USER_ID_Attr
```
    References the value used for the USER_ID attribute.
    
    See Also:
    
    Constant Field Values
  - CATENTREL_CATENTRY_ID_CHILD_Attr
```
public static final int CATENTREL_CATENTRY_ID_CHILD_Attr
```
    References the value used for the CATENTRY_ID_CHILD column of the CATENTREL database table
    
    See Also:
    
    Constant Field Values
  - CATENTREL_CATENTRY_ID_PARENT_Attr
```
public static final int CATENTREL_CATENTRY_ID_PARENT_Attr
```
    References the value used for the CATENTRY_ID_PARENT column of the CATENTREL database table
    
    See Also:
    
    Constant Field Values
  - CATENTREL_CATREL_TYPE_ID_Attr
```
public static final int CATENTREL_CATREL_TYPE_ID_Attr
```
    References the value used for the CATREL_TYPE_ID column of the CATENTREL database table
    
    See Also:
    
    Constant Field Values
  - ATTRIBUTE_NAME_Attr
```
public static final int ATTRIBUTE_NAME_Attr
```
    References the value used for the NAME column of the ATTRIBUTE database table
    
    See Also:
    
    Constant Field Values
  - ATTRIBUTE_LANGUAGE_ID_Attr
```
public static final int ATTRIBUTE_LANGUAGE_ID_Attr
```
    References the value used for the LANGUAGE_ID column of the ATTRIBUTE database table
    
    See Also:
    
    Constant Field Values
  - ATTRIBUTE_CATENTRY_ID_Attr
```
public static final int ATTRIBUTE_CATENTRY_ID_Attr
```
    References the value used for the CATENTRY_ID column of the ATTRIBUTE database table
    
    See Also:
    
    Constant Field Values
  - ATTRIBUTE_ATTRIBUTE_ID_Attr
```
public static final int ATTRIBUTE_ATTRIBUTE_ID_Attr
```
    References the value used for the ATTRIBUTE_ID column of the ATTRIBUTE database table
    
    See Also:
    
    Constant Field Values
  - ATTRVALUE_LANGUAGE_ID_Attr
```
public static final int ATTRVALUE_LANGUAGE_ID_Attr
```
    References the value used for the LANGUAGE_ID column of the ATTRVALUE database table
    
    See Also:
    
    Constant Field Values
  - ATTRVALUE_NAME_Attr
```
public static final int ATTRVALUE_NAME_Attr
```
    References the value used for the NAME column of the ATTRVALUE database table
    
    See Also:
    
    Constant Field Values
  - ATTRVALUE_CATENTRY_ID_Attr
```
public static final int ATTRVALUE_CATENTRY_ID_Attr
```
    References the value used for the CATENTRY_ID column of the ATTRVALUE database table
    
    See Also:
    
    Constant Field Values
  - ATTRVALUE_STRINGVALUE_Attr
```
public static final int ATTRVALUE_STRINGVALUE_Attr
```
    References the value used for the STRINGVALUE column of the ATTRVALUE database table
    
    See Also:
    
    Constant Field Values
  - ATTRVALUE_ATTRIBUTE_ID_Attr
```
public static final int ATTRVALUE_ATTRIBUTE_ID_Attr
```
    References the value used for the ATTRIBUTE_ID column of the ATTRVALUE database table
    
    See Also:
    
    Constant Field Values
  - ATTRVALUE_FLOATVALUE_Attr
```
public static final int ATTRVALUE_FLOATVALUE_Attr
```
    References the value used for the FLOATVALUE column of the ATTRVALUE database table
    
    See Also:
    
    Constant Field Values
  - ATTRVALUE_INTEGERVALUE_Attr
```
public static final int ATTRVALUE_INTEGERVALUE_Attr
```
    References the value used for the INTEGERVALUE column of the ATTRVALUE database table
    
    See Also:
    
    Constant Field Values
  - CATGPENREL_CATGROUP_ID_Attr
```
public static final int CATGPENREL_CATGROUP_ID_Attr
```
    References the value used for the CATGROUP_ID column of the CATGPENREL database table
    
    See Also:
    
    Constant Field Values
  - CATGPENREL_CATENTRY_ID_Attr
```
public static final int CATGPENREL_CATENTRY_ID_Attr
```
    References the value used for the CATENTRY_ID column of the CATGPENREL database table
    
    See Also:
    
    Constant Field Values
  - CATGPENREL_CATALOG_ID_Attr
```
public static final int CATGPENREL_CATALOG_ID_Attr
```
    References the value used for the CATALOG_ID column of the CATGPENREL database table
    
    See Also:
    
    Constant Field Values
  - CATGROUP_CATGROUP_ID_Attr
```
public static final int CATGROUP_CATGROUP_ID_Attr
```
    References the value used for the CATGROUP_ID column of the CATGROUP database table
    
    See Also:
    
    Constant Field Values
  - CATGROUP_MARKFORDELETE_Attr
```
public static final int CATGROUP_MARKFORDELETE_Attr
```
    References the value used for the MARKFORDELETE column of the CATGROUP database table
    
    See Also:
    
    Constant Field Values
  - CATGROUP_LASTUPDATE_Attr
```
public static final int CATGROUP_LASTUPDATE_Attr
```
    References the value used for the LASTUPDATE column of the CATGROUP database table
    
    See Also:
    
    Constant Field Values
  - CATGROUP_IDENTIFIER_ID_Attr
```
public static final int CATGROUP_IDENTIFIER_ID_Attr
```
    References the value used for the IDENTIFIER_ID column of the CATGROUP database table
    
    See Also:
    
    Constant Field Values
  - CATGROUP_IDENTIFIER_Attr
```
public static final int CATGROUP_IDENTIFIER_Attr
```
    References the value used for the IDENTIFIER column of the CATGROUP database table
    
    See Also:
    
    Constant Field Values
  - PRSETCEREL_PRODUCTSET_ID_Attr
```
public static final int PRSETCEREL_PRODUCTSET_ID_Attr
```
    References the value used for the PRODUCTSET_ID column of the PRSETCEREL database table
    
    See Also:
    
    Constant Field Values
  - PRSETCEREL_CATENTRY_ID_Attr
```
public static final int PRSETCEREL_CATENTRY_ID_Attr
```
    References the value used for the CATENTRY_ID column of the PRSETCEREL database table
    
    See Also:
    
    Constant Field Values
  - OFFERPRICE_PRICE_Attr
```
public static final int OFFERPRICE_PRICE_Attr
```
    References the value used for the PRICE column of the OFFERPRICE database table
    
    See Also:
    
    Constant Field Values
  - OFFERPRICE_OFFER_ID_Attr
```
public static final int OFFERPRICE_OFFER_ID_Attr
```
    References the value used for the OFFER_ID column of the CATEOFFERPRICE NTDESC database table
    
    See Also:
    
    Constant Field Values
  - OFFERPRICE_CURRENCY_Attr
```
public static final int OFFERPRICE_CURRENCY_Attr
```
    References the value used for the CURRENCY column of the CATEOFFERPRICE NTDESC database table
    
    See Also:
    
    Constant Field Values
  - OFFER_TRADEPOSCN_ID_Attr
```
public static final int OFFER_TRADEPOSCN_ID_Attr
```
    References the value used for the TRADEPOSCN_ID column of the OFFER database table
    
    See Also:
    
    Constant Field Values
  - OFFER_OFFER_ID_Attr
```
public static final int OFFER_OFFER_ID_Attr
```
    References the value used for the OFFER_ID column of the OFFER database table
    
    See Also:
    
    Constant Field Values
  - OFFER_MAXIMUMQUANTITY_Attr
```
public static final int OFFER_MAXIMUMQUANTITY_Attr
```
    References the value used for the MAXIMUMQUANTITY column of the OFFER database table
    
    See Also:
    
    Constant Field Values
  - OFFER_MINIMUMQUANTITY_Attr
```
public static final int OFFER_MINIMUMQUANTITY_Attr
```
    References the value used for the MINIMUMQUANTITY column of the OFFER database table
    
    See Also:
    
    Constant Field Values
  - TRADEPOSCN_TRADEPOSCN_ID_Attr
```
public static final int TRADEPOSCN_TRADEPOSCN_ID_Attr
```
    References the value used for the TRADEPOSCN_ID column of the TRADEPOSCN database table
    
    See Also:
    
    Constant Field Values
  - TRADEPOSCN_TYPE_ID_Attr
```
public static final int TRADEPOSCN_TYPE_ID_Attr
```
    References the value used for the TYPE_ID column of the TRADEPOSCN database table
    
    See Also:
    
    Constant Field Values
  - INVSTVW_QUANTITY_AVAILABLE_Attr
```
public static final int INVSTVW_QUANTITY_AVAILABLE_Attr
```
    References the value used for the QUANTITY_AVAILABLE column of the INVSTVW database table
    
    See Also:
    
    Constant Field Values
  - INVSTVW_QUANTITY_MEASURE_Attr
```
public static final int INVSTVW_QUANTITY_MEASURE_Attr
```
    References the value used for the QUANTITY_MEASURE column of the INVSTVW database table
    
    See Also:
    
    Constant Field Values
  - INVSTVW_STORE_ID_Attr
```
public static final int INVSTVW_STORE_ID_Attr
```
    References the value used for the STORE_ID column of the INVSTVW database table
    
    See Also:
    
    Constant Field Values
  - STDPRICEVW_PRICE_Attr
```
public static final int STDPRICEVW_PRICE_Attr
```
    References the value used for the PRICE column of the STDPRICEVW database table
    
    See Also:
    
    Constant Field Values
  - STDPRICEVW_CATENTRY_ID_Attr
```
public static final int STDPRICEVW_CATENTRY_ID_Attr
```
    References the value used for the CATENTRY_ID column of the STDPRICEVW database table
    
    See Also:
    
    Constant Field Values
  - STDPRICEVW_CURRENCY_Attr
```
public static final int STDPRICEVW_CURRENCY_Attr
```
    References the value used for the CURRENCY column of the STDPRICEVW database table
    
    See Also:
    
    Constant Field Values
  - CATALOG_CATALOG_ID_Attr
```
public static final int CATALOG_CATALOG_ID_Attr
```
    References the value used for the CATALOG_ID column of the CATALOG database table
    
    See Also:
    
    Constant Field Values
  - CATALOG_DESCRIPTION_Attr
```
public static final int CATALOG_DESCRIPTION_Attr
```
    References the value used for the DESCRIPTION column of the CATALOG database table
    
    See Also:
    
    Constant Field Values
  - CATALOG_IDENTIFIER_Attr
```
public static final int CATALOG_IDENTIFIER_Attr
```
    References the value used for the IDENTIFIER column of the CATALOG database table
    
    See Also:
    
    Constant Field Values
  - CATALOGDSC_NAME_Attr
```
public static final int CATALOGDSC_NAME_Attr
```
    References the value used for the NAME column of the CATALOGDSC database table
    
    See Also:
    
    Constant Field Values
  - CATALOGDSC_SHORTDESCRIPTION_Attr
```
public static final int CATALOGDSC_SHORTDESCRIPTION_Attr
```
    References the value used for the SHORTDESCRIPTION column of the CATALOGDSC database table
    
    See Also:
    
    Constant Field Values
  - CATALOGDSC_LANGUAGE_ID_Attr
```
public static final int CATALOGDSC_LANGUAGE_ID_Attr
```
    References the value used for the LANGUAGE_ID column of the CATALOGDSC database table
    
    See Also:
    
    Constant Field Values
  - STORECAT_MASTERCATALOG_Attr
```
public static final int STORECAT_MASTERCATALOG_Attr
```
    References the value used for the MASTERCATALOG column of the STORECAT database table
    
    See Also:
    
    Constant Field Values
  - STORECAT_STOREENT_ID_Attr
```
public static final int STORECAT_STOREENT_ID_Attr
```
    References the value used for the STOREENT_ID column of the STORECAT database table
    
    See Also:
    
    Constant Field Values
  - STORECGRP_STOREENT_ID_Attr
```
public static final int STORECGRP_STOREENT_ID_Attr
```
    References the value used for the STOREENT_ID column of the STORECGRP database table
    
    See Also:
    
    Constant Field Values
  - OR_Operator
```
public static final int OR_Operator
```
    References the value used for the OR Operator
    
    See Also:
    
    Constant Field Values
  - AND_Operator
```
public static final int AND_Operator
```
    References the value used for the AND Operator
    
    See Also:
    
    Constant Field Values
  - IS_NULL_Operator
```
public static final int IS_NULL_Operator
```
    References the value used for the IS_NULL Operator
    
    See Also:
    
    Constant Field Values
  - IS_NOT_NULL_Operator
```
public static final int IS_NOT_NULL_Operator
```
    References the value used for the IS_NOT_NULL Operator
    
    See Also:
    
    Constant Field Values
  - LIKE_Operator
```
public static final int LIKE_Operator
```
    References the value used for the LIKE Operator
    
    See Also:
    
    Constant Field Values
  - LEFT_LIKE_Operator
```
public static final int LEFT_LIKE_Operator
```
    References the value used for the LEFT_LIKE Operator
    
    See Also:
    
    Constant Field Values
  - RIGHT_LIKE_Operator
```
public static final int RIGHT_LIKE_Operator
```
    References the value used for the RIGHT_LIKE Operator
    
    See Also:
    
    Constant Field Values
  - NOT_LIKE_Operator
```
public static final int NOT_LIKE_Operator
```
    References the value used for the NOT_LIKE Operator
    
    See Also:
    
    Constant Field Values
  - NOT_LEFT_LIKE_Operator
```
public static final int NOT_LEFT_LIKE_Operator
```
    References the value used for the NOT_LEFT_LIKE Operator
    
    See Also:
    
    Constant Field Values
  - NOT_RIGHT_LIKE_Operator
```
public static final int NOT_RIGHT_LIKE_Operator
```
    References the value used for the NOT_RIGHT_LIKE Operator
    
    See Also:
    
    Constant Field Values
  - EQ_Operator
```
public static final int EQ_Operator
```
    References the value used for the EQ Operator
    
    See Also:
    
    Constant Field Values
  - GT_Operator
```
public static final int GT_Operator
```
    References the value used for the GT Operator
    
    See Also:
    
    Constant Field Values
  - GE_Operator
```
public static final int GE_Operator
```
    References the value used for the GE Operator
    
    See Also:
    
    Constant Field Values
  - LT_Operator
```
public static final int LT_Operator
```
    References the value used for the LT Operator
    
    See Also:
    
    Constant Field Values
  - LE_Operator
```
public static final int LE_Operator
```
    References the value used for the LE Operator
    
    See Also:
    
    Constant Field Values
  - NE_Operator
```
public static final int NE_Operator
```
    References the value used for the NE Operator
    
    See Also:
    
    Constant Field Values
  - IN_Operator
```
public static final int IN_Operator
```
    References the value used for the IN Operator
    
    See Also:
    
    Constant Field Values
  - NOT_IN_Operator
```
public static final int NOT_IN_Operator
```
    References the value used for the NOT_IN Operator
    
    See Also:
    
    Constant Field Values
  - NOT_GT_Operator
```
public static final int NOT_GT_Operator
```
    References the value used for the NOT_GT Operator
    
    See Also:
    
    Constant Field Values
  - NOT_LT_Operator
```
public static final int NOT_LT_Operator
```
    References the value used for the NOT_LT Operator
    
    See Also:
    
    Constant Field Values
  - GROUP_BY_Operator
```
public static final int GROUP_BY_Operator
```
    References the value used for the GROUP_BY Operator
    
    See Also:
    
    Constant Field Values
  - ORDER_BY_Operator
```
public static final int ORDER_BY_Operator
```
    References the value used for the ORDER_BY Operator
    
    See Also:
    
    Constant Field Values
  - COUNT_Operator
```
public static final int COUNT_Operator
```
    References the value used for the COUNT Operator
    
    See Also:
    
    Constant Field Values
  - ASC_Operator
```
public static final int ASC_Operator
```
    References the value used for the ASC Operator
    
    See Also:
    
    Constant Field Values
  - DESC_Operator
```
public static final int DESC_Operator
```
    References the value used for the DESC Operator
    
    See Also:
    
    Constant Field Values
  - MIN_Operator
```
public static final int MIN_Operator
```
    References the value used for the MIN Operator
    
    See Also:
    
    Constant Field Values
  - MAX_Operator
```
public static final int MAX_Operator
```
    References the value used for the MAX Operator
    
    See Also:
    
    Constant Field Values
  - SUM_Operator
```
public static final int SUM_Operator
```
    References the value used for the SUM Operator
    
    See Also:
    
    Constant Field Values
  - AVG_Operator
```
public static final int AVG_Operator
```
    References the value used for the AVG Operator
    
    See Also:
    
    Constant Field Values
  - UPPER_Function
```
public static final int UPPER_Function
```
    References the value used for the UPPER function
    
    See Also:
    
    Constant Field Values
  - GENERIC_QueryType
```
public static final int GENERIC_QueryType
```
    References the value used for the GENERIC Query Type
    
    See Also:
    
    Constant Field Values
  - CATENTRY_SKU_QueryType
```
public static final int CATENTRY_SKU_QueryType
```
    References the value used for the CATENTRY_SKU function
    
    See Also:
    
    Constant Field Values
  - ANY_QueryType
```
public static final int ANY_QueryType
```
    References the value used for the ANY Query Type
    
    See Also:
    
    Constant Field Values
  - ITEM_QueryType
```
public static final int ITEM_QueryType
```
    References the value used for the ITEM Query Type
    
    See Also:
    
    Constant Field Values
  - BOTH_QueryType
```
public static final int BOTH_QueryType
```
    References the value used for the BOTH Query Type
    
    See Also:
    
    Constant Field Values
  - ITEM_CatEntryType
```
public static final int ITEM_CatEntryType
```
    References the value used for the ITEM CatEntry Type
    
    See Also:
    
    Constant Field Values
  - BUNDLE_CatEntryType
```
public static final int BUNDLE_CatEntryType
```
    References the value used for the BUNDLE CatEntry Type
    
    See Also:
    
    Constant Field Values
  - PACKAGE_CatEntryType
```
public static final int PACKAGE_CatEntryType
```
    References the value used for the PACKAGE CatEntry Type
    
    See Also:
    
    Constant Field Values
  - PRODUCT_CatEntryType
```
public static final int PRODUCT_CatEntryType
```
    References the value used for the PRODUCT CatEntry Type
    
    See Also:
    
    Constant Field Values
  - DYNAMICKIT_CatEntryType
```
public static final int DYNAMICKIT_CatEntryType
```
    References the value used for the DYNAMICKIT CatEntry Type
    
    See Also:
    
    Constant Field Values
  - defaultResultSelection
```
public boolean defaultResultSelection
```
    The default result selection boolean value
  - isProduct
```
public boolean isProduct
```
    The boolean value representing the isProduct attribute
  - isItem
```
public boolean isItem
```
    The boolean value representing the isItem attribute
  - isBundle
```
public boolean isBundle
```
    The boolean value representing the isBundle attribute
  - isPackage
```
public boolean isPackage
```
    The boolean value representing the isPackage attribute
  - isDynamicKit
```
public boolean isDynamicKit
```
    The boolean value representing the isDynamicKit attribute
  - isAll
```
public boolean isAll
```
    The boolean value representing the isAll attribute
- Constructor Detail
  - RuleQuery
```
public RuleQuery()
```
    RuleQuery constructor with no arguments.
  - RuleQuery
```
public RuleQuery(TradingAgreementAccessBean[] agreements)
```
    Deprecated. Replaced by RuleQuery(TradingAgreementAccessBean[] agreements, Long userId).
    
    RuleQuery constructor with Trading agreement access bean as argument.
  - RuleQuery
```
public RuleQuery(TradingAgreementAccessBean[] agreements,
                 java.lang.Long userId)
```
    RuleQuery constructor with Trading Agreement Access bean and user id as arguments.
    
    Parameters:
    
    agreements - The trading agreement access bean array to process entitlement.
    
    userId - The user id to process entitlement.
  - RuleQuery
```
public RuleQuery(int inStoreID,
                 TradingAgreementAccessBean[] agreements)
```
    Deprecated. Replaced by RuleQuery(int inStoreID, TradingAgreementAccessBean[] agreements, Long userId).
    
    RuleQuery constructor with store id and TradingAgreementAccessBean as arguments.
  - RuleQuery
```
public RuleQuery(int inStoreID,
                 TradingAgreementAccessBean[] agreements,
                 java.lang.Long userId)
```
    RuleQuery constructor with store id, Trading agreement access bean and user id as arguments.
    
    Parameters:
    
    inStoreID - The store id to be added to search criteria.
    
    agreements - The trading agreement access bean array to process entitlement.
    
    userId - The user id to process entitlement.
  - RuleQuery
```
public RuleQuery(int inStoreID,
                 int inUserID)
```
    Rule query constructor with store and user id as arguments.
    
    Parameters:
    
    inStoreID - The store id that will be added to search criteria.
    
    inUserID - The user id.
  - RuleQuery
```
public RuleQuery(com.ibm.commerce.search.base.Query q)
```
    RuleQuery constructor with Query as argument.
    
    Parameters:
    
    q - A query class
  - RuleQuery
```
public RuleQuery(java.util.Vector inStoreIDs,
                 TradingAgreementAccessBean[] agreements)
```
    Deprecated. Replaced by RuleQuery(Vector inStoreIDs, TradingAgreementAccessBean[] agreements, Long userId).
    
    Rule query constructor with multiple store id and trading agreement access bean as arguments.
  - RuleQuery
```
public RuleQuery(java.util.Vector inStoreIDs,
                 TradingAgreementAccessBean[] agreements,
                 java.lang.Long userId)
```
    RuleQuery constructor with multiple store id, Trading agreement access bean and user id as arguments.
    
    Parameters:
    
    inStoreIDs - The store ids to be added to search criteria.
    
    agreements - The trading agreement access bean array to process entitlement.
    
    userId - The user id to process entitlement.
  - RuleQuery
```
public RuleQuery(java.util.Vector inStoreIDs,
                 int inUserID)
```
    Rule query constructor with multiple store id and single user id as arguments.
    
    Parameters:
    
    inStoreIDs - Store id collection that will be added to search criteria.
    
    inUserID - The user id.
- Method Detail
  - addFilterAttribute
```
public void addFilterAttribute(int attribute,
                               int operator)
                        throws java.lang.Exception
```
    Adds a predicate to query Where clause to filter a row, example, TABLE.COLUMN IS NOT NULL. This method will use compliment of specified operator. For example if the operator is LIKE then this method will convert it to NOTLIKE and if NOTLIKE it will be converted to LIKE.
    
    Parameters:
    
    attribute - The static integer constant equivalent of a column name. This value is attained from the attribute constants defined within this class.
    
    operator - The static integer constant equivalent of an operator. This value is attained from the operator constants defined within this class.
    
    Throws:
    
    java.lang.Exception
  - addFilterAttribute
```
public void addFilterAttribute(int attribute,
                               int operator,
                               int function)
                        throws java.lang.Exception
```
    Adds a predicate to query Where clause to filter a row, example FUNCTION(TABLE.COLUMN) IS NULL. This method will use compliment of specified operator. For example if the operator is LIKE then this method will convert it to NOTLIKE. The attribute, operator, and function parameter values are obtained from the corresponding constants defined within this class.
    
    Parameters:
    
    attribute - The static integer constant equivalent of a column name.
    
    operator - The static integer constant equivalent of an operator.
    
    function - The static integer constant equivalent of a function. At present only UPPER function is supported.
    
    Throws:
    
    java.lang.Exception
  - addFilterAttribute
```
public void addFilterAttribute(int attribute,
                               int operator,
                               java.lang.String value)
                        throws java.lang.Exception
```
    Adds a predicate to query Where clause to filter a row, example, TABLE.COLUMN LIKE '%VALUE%'. This method will use compliment of specified operator. For example if the operator is LIKE then this method will convert it to NOTLIKE. The attribute and operator parameter values are obtained from the corresponding constants defined within this class.
    
    Parameters:
    
    attribute - The static integer constant equivalent of a column name.
    
    operator - The static integer constant equivalent of an operator.
    
    value - The value to be filtered from the database.
    
    Throws:
    
    java.lang.Exception
  - addFilterAttribute
```
public void addFilterAttribute(int attribute,
                               int operator,
                               java.lang.String value,
                               int function)
                        throws java.lang.Exception
```
    Adds a predicate to query Where clause to filter a row, example FUNCTION(TABLE.COLUMN) LIKE '%VALUE%'. This method will use compliment of specified operator. For example if the operator is LIKE then this method will convert it to NOTLIKE. The attribute, operator, and function parameter values are obtained from the corresponding constants defined within this class.
    
    Parameters:
    
    attribute - The static integer constant equivalent of a column name.
    
    operator - The static integer constant equivalent of an operator.
    
    value - The value to be filtered from the database.
    
    function - The static integer constant equivalent of a function. At present only UPPER function is supported.
    
    Throws:
    
    java.lang.Exception
  - addFilterOperand
```
public void addFilterOperand(com.ibm.commerce.search.base.Attribute attr)
                      throws java.lang.Exception
```
    Adds a WHERE clause predicate into temporary filter predicate collection.
    
    Parameters:
    
    attr - A WHERE clause predicate
    
    Throws:
    
    java.lang.Exception
  - addFilterOperand
```
public void addFilterOperand(com.ibm.commerce.search.base.Predicate predicate)
                      throws java.lang.Exception
```
    Adds a collection of WHERE clause predicates into temporary filter predicate collection.
    
    Parameters:
    
    predicate - A collection of WHERE clause predicates
    
    Throws:
    
    java.lang.Exception
  - addFilterOperator
```
public void addFilterOperator(int operator)
```
    Adds an operator that combines a set of filter predicates. The logic for post-fix resides in this method. The operator parameter values are obtained from the corresponding constants defined within this class.
    
    Parameters:
    
    operator - The static integer constant equivalent of an operator.
  - addGlobalPredicate
```
public void addGlobalPredicate(com.ibm.commerce.search.base.Predicate globalPredicate)
```
    Method to insert a predicate that will be applied to entire query like BUYABLE/PUBLISHABLE/LANGUAGE_ID. The Global predicate will be ANDed with the selectSet/filterSet. Set the globalPredicate variable
    
    Parameters:
    
    globalPredicate - The global predicate.
  - addGroupByAttribute
```
public void addGroupByAttribute(int attribute)
                         throws java.lang.Exception
```
    To set group by operator The attribute parameter values are obtained from the corresponding constants defined within this class.
    
    Parameters:
    
    attribute - The integer representing the attribute info class.
    
    Throws:
    
    java.lang.Exception
  - addGroupByAttribute
```
public void addGroupByAttribute(java.lang.String attribute)
                         throws java.lang.Exception
```
    To set group by operator.
    
    Parameters:
    
    attribute - The attribute info class name.
    
    Throws:
    
    java.lang.Exception
  - addOrderByAttribute
```
public void addOrderByAttribute(int attribute,
                                int operator)
                         throws java.lang.Exception
```
    To set order by operator The attribute and operator parameter values are obtained from the corresponding constants defined within this class.
    
    Parameters:
    
    attribute - The static integer constant equivalent of a column name.
    
    operator - The operator static integer constant.
    
    Throws:
    
    java.lang.Exception
  - addOrderByAttribute
```
public void addOrderByAttribute(java.lang.String attribute,
                                java.lang.String operator)
                         throws java.lang.Exception
```
    To set order by operator
    
    Parameters:
    
    attribute - The string representation of a column name.
    
    operator - The operator string representation.
    
    Throws:
    
    java.lang.Exception
  - addOrderByAttribute1
```
public void addOrderByAttribute1(int attribute,
                                 int operator)
                          throws java.lang.Exception
```
    To set order by operator The attribute and operator parameter values are obtained from the corresponding constants defined within this class.
    
    Parameters:
    
    attribute - The static integer constant equivalent of a column name.
    
    operator - The operator static integer constant.
    
    Throws:
    
    java.lang.Exception
  - addResultAttribute
```
public void addResultAttribute(int resultAttribute)
                        throws java.lang.Exception
```
    To add valid result set.
    
    Parameters:
    
    resultAttribute - The result to be added.
    
    Throws:
    
    java.lang.Exception
  - addResultAttribute
```
public void addResultAttribute(java.lang.String attribute)
                        throws java.lang.Exception
```
    To add valid result set.
    
    Parameters:
    
    attribute - The result to be added.
    
    Throws:
    
    java.lang.Exception
  - addResultAttribute
```
public void addResultAttribute(java.lang.String attribute,
                               java.lang.String operator)
                        throws java.lang.Exception
```
    To add valid result set.
    
    Parameters:
    
    attribute - The string representation of a column name.
    
    operator - The operator string representation.
    
    Throws:
    
    java.lang.Exception
  - addRule
```
public void addRule()
```
    Adds a set of predicates to a Query. Must be specified after all the individual predicates are specified. The search interface can retrieve only Products, only Items or Both. By default the interface will retrieve only Products.
  - addRule
```
public void addRule(int aQueryType)
```
    Deprecated. Replaced by addRule().
    
    Adds a set of predicate to Query. Must be specified after all the individual predicates are specified.
    
    Parameters:
    
    aQueryType - The type of result to be retrieved by the query. The search interface can retrieve only Products, only Items or Both.
  - addSelectAttribute
```
public void addSelectAttribute(int attribute,
                               int operator)
                        throws java.lang.Exception
```
    Adds a predicate to query Where clause, example, TABLE.COLUMN IS NOT NULL. The attribute and operator parameter values are obtained from the corresponding constants defined within this class.
    
    Parameters:
    
    attribute - The static integer constant equivalent of a column name.
    
    operator - The static integer constant equivalent of an operator.
    
    Throws:
    
    java.lang.Exception
  - addSelectAttribute
```
public void addSelectAttribute(int attribute,
                               int operator,
                               int function)
                        throws java.lang.Exception
```
    Adds a predicate to query Where clause, example FUNCTION(TABLE.COLUMN) IS NULL. The attribute, operator, and function parameter values are obtained from the corresponding constants defined within this class.
    
    Parameters:
    
    attribute - The static integer constant equivalent of a column name.
    
    operator - The static integer constant equivalent of an operator.
    
    function - The static integer constant equivalent of a function. At present only UPPER function is supported.
    
    Throws:
    
    java.lang.Exception
  - addSelectAttribute
```
public void addSelectAttribute(int attribute,
                               int operator,
                               java.lang.String value)
                        throws java.lang.Exception
```
    Adds a predicate to query Where clause, example, TABLE.COLUMN LIKE '%VALUE%'. The attribute and operator parameter values are obtained from the corresponding constants defined within this class.
    
    Parameters:
    
    attribute - The static integer constant equivalent of a column name.
    
    operator - The static integer constant equivalent of an operator.
    
    value - The value to be filtered from the database.
    
    Throws:
    
    java.lang.Exception
  - addSelectAttribute
```
public void addSelectAttribute(int attribute,
                               int operator,
                               java.lang.String value,
                               int function)
                        throws java.lang.Exception
```
    Adds a predicate to query Where clause, example FUNCTION(TABLE.COLUMN) LIKE '%VALUE%'. This method will use compliment of specified operator. For example if the operator is LIKE then this method will convert it to NOTLIKE. The attribute, operator, and function parameter values are obtained from the corresponding constants defined within this class.
    
    Parameters:
    
    attribute - The static integer constant equivalent of a column name.
    
    operator - The static integer constant equivalent of an operator.
    
    value - The value to be filtered from the database.
    
    function - The static integer constant equivalent of a function. At present only UPPER function is supported.
    
    Throws:
    
    java.lang.Exception
  - addSelectAttribute
```
public void addSelectAttribute(java.lang.String attribute,
                               int operator,
                               java.lang.String value)
                        throws java.lang.Exception
```
    Deprecated. Replaced by addSelectAttribute(int attribute, int operator, String value).
    
    Adds a Rich attribute predicate. This method only supports NAME column in AttrValue column.
    
    Parameters:
    
    attribute - An attribute defined in Attribute table, for example Color, Size.
    
    operator - The static integer operator constant.
    
    value - The value of an attribute defined in AttrValue table, for example Red, Length = 32.
    
    Throws:
    
    java.lang.Exception
  - addSelectAttribute
```
public void addSelectAttribute(java.lang.String attribute,
                               int operator,
                               java.lang.String value,
                               int attrValueType,
                               java.lang.String languageId,
                               java.lang.String prodType)
                        throws java.lang.Exception
```
    Adds a Rich attribute predicate. This method supports NAME, STRINGVALUE, FLOATVALUE and INTEGERVALUE column in AttrValue column. The operator parameter values are obtained from the corresponding constants defined within this class.
    
    Parameters:
    
    attribute - A search attribute, for example Color, Size.
    
    operator - The static integer operator constant.
    
    value - The value of a search attribute, for example Red, Length = 32.
    
    attrValueType - The column in AttrValue table that must be used to search for the value, example Integervalue, Stringvalue, Floatvalue or Name.
    
    languageId - The language id that must be used for searching the rich attribute.
    
    prodType - The Parent - Child relationship defined in CATENREL table. At present this method only supports Product_Item or NULL.
    
    Throws:
    
    java.lang.Exception
  - addSelectAttribute
```
public void addSelectAttribute(java.lang.String attribute,
                               int operator,
                               java.lang.String value,
                               int attrValueType,
                               java.lang.String languageId,
                               java.lang.String prodType,
                               int function)
                        throws java.lang.Exception
```
    Adds a Rich attribute predicate. This method only supports NAME, STRINGVALUE, FLOATVALUE and INTEGERVALUE column in AttrValue column. The operator and function parameter values are obtained from the corresponding constants defined within this class.
    
    Parameters:
    
    attribute - A search attribute, for example Color, Size.
    
    operator - The static integer operator constant.
    
    value - The value of a search attribute, for example Red, Length = 32.
    
    attrValueType - The column in AttrValue table that must be used to search for the value, example Integervalue, Stringvalue, Floatvalue or Name.
    
    languageId - The language id that must be used for searching the rich attribute.
    
    prodType - The Parent - Child relationship defined in CATENREL table. At present this method only supports Product_Item or NULL.
    
    function - The static integer operator for UPPER function
    
    Throws:
    
    java.lang.Exception
  - addSelectAttribute
```
public void addSelectAttribute(java.lang.String attribute,
                               int operator,
                               java.lang.String value,
                               java.lang.String languageId,
                               java.lang.String prodType)
                        throws java.lang.Exception
```
    Deprecated. Replaced by addSelectAttribute(String attribute, int operator, String value, int attrValueType, String languageId, String prodType, int function).
    
    Adds a Rich attribute predicate. This method only supports NAME column in AttrValue column. The operator parameter values are obtained from the corresponding constants defined within this class.
    
    Parameters:
    
    attribute - A search attribute, for example Color, Size.
    
    operator - The static integer operator constant.
    
    value - The value of a search attribute, for example Red, Length = 32.
    
    languageId - The language id that must be used for searching the rich attribute.
    
    prodType - The Parent - Child relationship defined in CATENREL table. At present this method only supports Product_Item or NULL.
    
    Throws:
    
    java.lang.Exception
  - addSelectAttribute
```
public void addSelectAttribute(java.lang.String attribute,
                               int operator,
                               java.lang.String value,
                               java.lang.String languageId,
                               java.lang.String prodType,
                               int function)
                        throws java.lang.Exception
```
    Deprecated. Replaced by addSelectAttribute(String attribute, int operator, String value, int attrValueType, String languageId, String prodType, int function).
    
    Adds a Rich attribute predicate. This method only supports NAME, STRINGVALUE, FLOATVALUE and INTEGERVALUE column in AttrValue column. The operator and function parameter values are obtained from the corresponding constants defined within this class.
    
    Parameters:
    
    attribute - A search attribute, for example Color, Size.
    
    operator - The static integer operator constant.
    
    value - The value of a search attribute, for example Red, Length = 32.
    
    languageId - The language id that must be used for searching the rich attribute.
    
    prodType - The Parent - Child relationship defined in CATENREL table. At present this method only supports Product_Item or NULL.
    
    function - The static integer operator for UPPER function
    
    Throws:
    
    java.lang.Exception
  - addSelectOperand
```
public void addSelectOperand(com.ibm.commerce.search.base.Attribute attr)
                      throws java.lang.Exception
```
    Adds a WHERE clause predicate into temporary select set predicate collection.
    
    Parameters:
    
    attr - A WHERE clause predicate
    
    Throws:
    
    java.lang.Exception
  - addSelectOperand
```
public void addSelectOperand(com.ibm.commerce.search.base.Predicate predicate)
                      throws java.lang.Exception
```
    Adds a collection of WHERE clause predicates into temporary select set predicate collection. Before adding to the collection this method may translate the collection of predicates into a sub-query. At present the translation is supported for following table columns CATGPENREL.CATGROUP_ID and CATGRPDESC.NAME or SHORTDESC or LONGDESC.
    
    Parameters:
    
    predicate - A collection of predicates.
    
    Throws:
    
    java.lang.Exception
  - addSelectOperator
```
public void addSelectOperator(int operator)
```
    Adds an operator that combines a set of filter predicates. The logic for post-fix resides in this method. The operator parameter values are obtained from the corresponding constants defined within this class.
    
    Parameters:
    
    operator - The static integer constant equivalent of an operator.
  - execute
```
public java.util.Vector execute()
                         throws java.lang.Exception
```
    Executes catalog search query and retrieves all the catentry ids that satisfy the query.
    
    Returns:
    
    A collection of catentry ids.
    
    Throws:
    
    java.lang.Exception
  - execute
```
public java.util.Vector execute(com.ibm.commerce.base.objects.Cursor aCursor)
                         throws java.lang.Exception
```
    Executes catalog search query and retrieves a set of catentry id between a start value and end value specified in the cursor object.
    
    Parameters:
    
    aCursor - The cursor object.
    
    Returns:
    
    A collection of catentry ids between a start value and end value specified in the cursor object.
    
    Throws:
    
    java.lang.Exception
  - execute
```
public com.ibm.commerce.dynacache.commands.CachedCollectionEnumeration execute(int aInitialIndex,
                                                                               com.ibm.commerce.dynacache.commands.AbstractDistributedMapCache aDistributedMapCache)
                                                                        throws java.lang.Exception
```
    Gets a cached result or executes a catalog search query to retrieves an enumeration of catentry id.
    
    Parameters:
    
    aInitialIndex - the initial zero based index for the returned enumeration.
    
    aDistributedMapCache - used to do the caching.
    
    Returns:
    
    A collection of catentry ids
    
    Throws:
    
    java.lang.Exception
  - findStorePaths
```
public java.util.Vector findStorePaths(int sid)
                                throws java.lang.Exception
```
    This method can be used to find store paths for a store id
    
    Parameters:
    
    sid - The store id.
    
    Returns:
    
    store paths or null.
    
    Throws:
    
    java.lang.Exception
  - getCatgrpSchemaType
```
public java.lang.Integer getCatgrpSchemaType()
```
    Returns the catgroup schema type.
    
    Returns:
    
    the catgroup schema type.
  - getLongUserId
```
public java.lang.Long getLongUserId()
```
    Returns the user id of type Long.
    
    Returns:
    
    the user id.
  - getMcQuery
```
public com.ibm.commerce.search.base.Query getMcQuery()
```
    Returns the query object.
    
    Returns:
    
    the query.
  - getPredicate
```
public com.ibm.commerce.search.base.Predicate getPredicate()
                                                    throws java.lang.Exception
```
    Returns the selectSet and filterSet predicate.
    
    Returns:
    
    the predicate
    
    Throws:
    
    java.lang.Exception
  - getQueryType
```
public int getQueryType()
```
    Returns the query type.
    
    Returns:
    
    the query type.
  - getRASchemaType
```
public java.lang.Integer getRASchemaType()
```
    Returns RASchemaType.
    
    Returns:
    
    the schema type.
  - getResultSet
```
public java.util.Vector getResultSet()
```
    Returns the query result set.
    
    Returns:
    
    the query result. Each element is a Vector of column values.
  - getSelectivitySize
```
public int getSelectivitySize()
```
    Returns the selectivity size.
    
    Returns:
    
    the size.
  - getSourceTables
```
public java.util.Vector getSourceTables()
```
    Returns the tables used in the query from clause.
    
    Returns:
    
    the source tables. Each element is a Table.
  - getStoreID
```
public java.lang.Integer getStoreID()
```
    Returns the store id.
    
    Returns:
    
    the store id.
  - getStoreIDs
```
public java.util.Vector getStoreIDs()
```
    Returns the collection of store id.
    
    Returns:
    
    the store ids. Each element is an Integer.
  - getUserID
```
public java.lang.Integer getUserID()
```
    Returns the user id of type integer.
    
    Returns:
    
    the user id.
  - initialize
```
public void initialize()
```
    Initialize dictionary containing meta-data for attribute information
  - isPriceSummary
```
public boolean isPriceSummary()
```
    Returns if there is summary table for price or not
    
    Returns:
    
    true if there is summary table false otherwise
  - reset
```
public void reset()
```
    Re-initialize filterSet and selectSet variables
  - resetQueryType
```
public void resetQueryType()
```
    Method to reset queryType to override default.
  - setAgreements
```
public void setAgreements(TradingAgreementAccessBean[] newAgreements)
```
    To set trading agreements.
    
    Parameters:
    
    newAgreements - com.ibm.commerce.contract.objects.TradingAgreementAccessBean[]
  - setCatgrpSchemaType
```
public void setCatgrpSchemaType(java.lang.Integer newCatgrpSchemaType)
```
    To set catgrpSchemaType.
    
    Parameters:
    
    newCatgrpSchemaType - java.lang.Integer
  - setDefaultResultSelection
```
public void setDefaultResultSelection()
```
    To set default result selection variable.
  - setDistinct
```
public void setDistinct()
```
    To set distinct operator
  - setDistinct
```
public void setDistinct(boolean distinctFlag)
```
    To set distinct operator.
    
    Parameters:
    
    distinctFlag - true to set distinct, false otherwise.
  - setLongUserId
```
public void setLongUserId(java.lang.Long newLongUserId)
```
    Deprecated. Replaced by RuleQuery(TradingAgreementAccessBean[] agreements, Long userId), RuleQuery(int inStoreID, TradingAgreementAccessBean[] agreements, Long userId), RuleQuery(int inStoreID, int inUserID).
    
    To set the user id.
    
    Parameters:
    
    newLongUserId - java.lang.Long
  - setRASchemaType
```
public void setRASchemaType(java.lang.Integer newRASchemaType)
```
    To set the schema type.
    
    Parameters:
    
    newRASchemaType - java.lang.Integer
  - setSelectivitySize
```
public void setSelectivitySize(int newSelectivitySize)
```
    Set selectivity size
    
    Parameters:
    
    newSelectivitySize - The new selectivity size.
  - setStoreID
```
public void setStoreID(java.lang.Integer newStoreID)
```
    Set store id.
    
    Parameters:
    
    newStoreID - The new store id.
  - setStoreIDs
```
public void setStoreIDs(java.util.Vector newStoreIDs)
```
    Set collection of store ids
    
    Parameters:
    
    newStoreIDs - The new store ids.
  - setUserID
```
public void setUserID(int newUserID)
```
    Deprecated. Replaced by RuleQuery(TradingAgreementAccessBean[] agreements, Long userId), RuleQuery(int inStoreID, TradingAgreementAccessBean[] agreements, Long userId), RuleQuery(int inStoreID, int inUserID).
    
    Set user id
    
    Parameters:
    
    newUserID - The new user id.
  - toString
```
public java.lang.String toString()
```
    Returns query string
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    The query as string.
  - getLocale
```
public java.util.Locale getLocale()
```
    gets the locale used in the query.
    
    Returns:
    
    the locale used in the query.
  - setLocale
```
public void setLocale(java.util.Locale locale)
```
    sets the locale used in the query.
    
    Parameters:
    
    locale - the locale.
  - getOptCatgrpPredicate
```
public com.ibm.commerce.search.base.Predicate getOptCatgrpPredicate()
```
    Gets the Predicate optCatgrpPredicate to be used in the query.
    
    Returns:
    
    the Predicate optCatgrpPredicate to be used in the query.
  - setOptCatgrpPredicate
```
public void setOptCatgrpPredicate(com.ibm.commerce.search.base.Predicate anOptCatgrpPredicate)
```
    Sets the Predicate optCatgrpPredicate to be used in the query.
    
    Parameters:
    
    anOptCatgrpPredicate - a Predicate optCatgrpPredicate object.

Methods inherited from class java.lang.Object

COPYRIGHT

LISTPRICE_LISTPRICE_Attr

LISTPRICE_Attr

LISTPRICE_CURRENCY_Attr

LISTPRICE_CATENTRY_ID_Attr

STOREINVENTORY_QUANTITY_Attr

STOREINVENTORY_QUANTITY_MEASURE_Attr

CATGRPDESC_NAME_Attr

CATGRPDESC_LANGUAGE_ID_Attr

CATGRPDESC_LONGDESCRIPTION_Attr

CATGRPDESC_SHORTDESCRIPTION_Attr

CATGRPDESC_KEYWORD_Attr

CATGRPDESC_PUBLISHED_Attr

CATENTRY_SKU_Attr

CATENTRY_CATENTRY_ID_Attr

CATENTRY_ID_Attr

CATENTRY_BUYABLE_Attr

CATENTRY_ONAUCTION_Attr

CATENTRY_ONSPECIAL_Attr

CATENTRY_PARTNUMBER_Attr

CATENTRY_MFNAME_Attr

CATENTRY_MFPARTNUMBER_Attr

CATENTRY_MARKFORDELETE_Attr

CATENTRY_LASTUPDATE_Attr

CATENTRY_CATENTTYPE_ID_Attr

CATENTRY_FIELD4_Attr

CATENTRY_FIELD1_Attr

CATENTRY_FIELD2_Attr

CATENTRY_FIELD3_Attr

CATENTRY_FIELD5_Attr

CATENTDESC_NAME_Attr

CATENTDESC_AVAILABILITY_DATE_Attr

CATENTDESC_LANGUAGE_ID_Attr

CATENTDESC_PUBLISHED_Attr

CATENTDESC_SHORT_DESC_Attr

CATENTDESC_CATENTRY_ID_Attr

CATENTDESC_THUMBNAIL_Attr

CATENTDESC_LONGDESCRIPTION_Attr

CATENTDESC_SHORTDESCRIPTION_Attr

CATENTDESC_PARTNUMBER_Attr

CATENTDESC_KEYWORD_Attr

CATENTDESC_AVAILABLE_Attr

STORECATENTRY_STORE_ID_Attr

USER_ID_Attr

CATENTREL_CATENTRY_ID_CHILD_Attr

CATENTREL_CATENTRY_ID_PARENT_Attr

CATENTREL_CATREL_TYPE_ID_Attr

ATTRIBUTE_NAME_Attr

ATTRIBUTE_LANGUAGE_ID_Attr

ATTRIBUTE_CATENTRY_ID_Attr

ATTRIBUTE_ATTRIBUTE_ID_Attr

ATTRVALUE_LANGUAGE_ID_Attr

ATTRVALUE_NAME_Attr

ATTRVALUE_CATENTRY_ID_Attr

ATTRVALUE_STRINGVALUE_Attr

ATTRVALUE_ATTRIBUTE_ID_Attr

ATTRVALUE_FLOATVALUE_Attr

ATTRVALUE_INTEGERVALUE_Attr

CATGPENREL_CATGROUP_ID_Attr

CATGPENREL_CATENTRY_ID_Attr

CATGPENREL_CATALOG_ID_Attr

CATGROUP_CATGROUP_ID_Attr

CATGROUP_MARKFORDELETE_Attr

CATGROUP_LASTUPDATE_Attr

CATGROUP_IDENTIFIER_ID_Attr

CATGROUP_IDENTIFIER_Attr

PRSETCEREL_PRODUCTSET_ID_Attr

PRSETCEREL_CATENTRY_ID_Attr

OFFERPRICE_PRICE_Attr

OFFERPRICE_OFFER_ID_Attr

OFFERPRICE_CURRENCY_Attr

OFFER_TRADEPOSCN_ID_Attr

OFFER_OFFER_ID_Attr

OFFER_MAXIMUMQUANTITY_Attr

OFFER_MINIMUMQUANTITY_Attr

TRADEPOSCN_TRADEPOSCN_ID_Attr

TRADEPOSCN_TYPE_ID_Attr

INVSTVW_QUANTITY_AVAILABLE_Attr

INVSTVW_QUANTITY_MEASURE_Attr