public class RuleQuery
extends java.lang.Object
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.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 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.
|
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.
|
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.
|
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.
|
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.
|
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)
|
void |
addSelectAttribute(java.lang.String attribute,
int operator,
java.lang.String value,
java.lang.String languageId,
java.lang.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)
|
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)
|
java.lang.String |
toString()
Returns query string
|
public static final java.lang.String COPYRIGHT
public static final int LISTPRICE_LISTPRICE_Attr
public static final int LISTPRICE_Attr
public static final int LISTPRICE_CURRENCY_Attr
public static final int LISTPRICE_CATENTRY_ID_Attr
public static final int STOREINVENTORY_QUANTITY_Attr
public static final int STOREINVENTORY_QUANTITY_MEASURE_Attr
public static final int CATGRPDESC_NAME_Attr
public static final int CATGRPDESC_LANGUAGE_ID_Attr
public static final int CATGRPDESC_LONGDESCRIPTION_Attr
public static final int CATGRPDESC_SHORTDESCRIPTION_Attr
public static final int CATGRPDESC_KEYWORD_Attr
public static final int CATGRPDESC_PUBLISHED_Attr
public static final int CATENTRY_SKU_Attr
public static final int CATENTRY_CATENTRY_ID_Attr
public static final int CATENTRY_ID_Attr
public static final int CATENTRY_BUYABLE_Attr
public static final int CATENTRY_ONAUCTION_Attr
public static final int CATENTRY_ONSPECIAL_Attr
public static final int CATENTRY_PARTNUMBER_Attr
public static final int CATENTRY_MFNAME_Attr
public static final int CATENTRY_MFPARTNUMBER_Attr
public static final int CATENTRY_MARKFORDELETE_Attr
public static final int CATENTRY_LASTUPDATE_Attr
public static final int CATENTRY_CATENTTYPE_ID_Attr
public static final int CATENTRY_FIELD4_Attr
catentry
tablepublic static final int CATENTRY_FIELD1_Attr
catentry
tablepublic static final int CATENTRY_FIELD2_Attr
catentry
tablepublic static final int CATENTRY_FIELD3_Attr
catentry
tablepublic static final int CATENTRY_FIELD5_Attr
catentry
tablepublic static final int CATENTDESC_NAME_Attr
public static final int CATENTDESC_AVAILABILITY_DATE_Attr
public static final int CATENTDESC_LANGUAGE_ID_Attr
public static final int CATENTDESC_PUBLISHED_Attr
public static final int CATENTDESC_SHORT_DESC_Attr
public static final int CATENTDESC_CATENTRY_ID_Attr
public static final int CATENTDESC_THUMBNAIL_Attr
public static final int CATENTDESC_LONGDESCRIPTION_Attr
public static final int CATENTDESC_SHORTDESCRIPTION_Attr
public static final int CATENTDESC_PARTNUMBER_Attr
public static final int CATENTDESC_KEYWORD_Attr
public static final int CATENTDESC_AVAILABLE_Attr
public static final int STORECATENTRY_STORE_ID_Attr
public static final int USER_ID_Attr
public static final int CATENTREL_CATENTRY_ID_CHILD_Attr
public static final int CATENTREL_CATENTRY_ID_PARENT_Attr
public static final int CATENTREL_CATREL_TYPE_ID_Attr
public static final int ATTRIBUTE_NAME_Attr
public static final int ATTRIBUTE_LANGUAGE_ID_Attr
public static final int ATTRIBUTE_CATENTRY_ID_Attr
public static final int ATTRIBUTE_ATTRIBUTE_ID_Attr
public static final int ATTRVALUE_LANGUAGE_ID_Attr
public static final int ATTRVALUE_NAME_Attr
public static final int ATTRVALUE_CATENTRY_ID_Attr
public static final int ATTRVALUE_STRINGVALUE_Attr
public static final int ATTRVALUE_ATTRIBUTE_ID_Attr
public static final int ATTRVALUE_FLOATVALUE_Attr
public static final int ATTRVALUE_INTEGERVALUE_Attr
public static final int CATGPENREL_CATGROUP_ID_Attr
public static final int CATGPENREL_CATENTRY_ID_Attr
public static final int CATGPENREL_CATALOG_ID_Attr
public static final int CATGROUP_CATGROUP_ID_Attr
public static final int CATGROUP_MARKFORDELETE_Attr
public static final int CATGROUP_LASTUPDATE_Attr
public static final int CATGROUP_IDENTIFIER_ID_Attr
public static final int CATGROUP_IDENTIFIER_Attr
public static final int PRSETCEREL_PRODUCTSET_ID_Attr
public static final int PRSETCEREL_CATENTRY_ID_Attr
public static final int OFFERPRICE_PRICE_Attr
public static final int OFFERPRICE_OFFER_ID_Attr
public static final int OFFERPRICE_CURRENCY_Attr
public static final int OFFER_TRADEPOSCN_ID_Attr
public static final int OFFER_OFFER_ID_Attr
public static final int OFFER_MAXIMUMQUANTITY_Attr
public static final int OFFER_MINIMUMQUANTITY_Attr
public static final int TRADEPOSCN_TRADEPOSCN_ID_Attr
public static final int TRADEPOSCN_TYPE_ID_Attr
public static final int INVSTVW_QUANTITY_AVAILABLE_Attr
public static final int INVSTVW_QUANTITY_MEASURE_Attr
public static final int INVSTVW_STORE_ID_Attr
public static final int STDPRICEVW_PRICE_Attr
public static final int STDPRICEVW_CATENTRY_ID_Attr
public static final int STDPRICEVW_CURRENCY_Attr
public static final int CATALOG_CATALOG_ID_Attr
public static final int CATALOG_DESCRIPTION_Attr
public static final int CATALOG_IDENTIFIER_Attr
public static final int CATALOGDSC_NAME_Attr
public static final int CATALOGDSC_SHORTDESCRIPTION_Attr
public static final int CATALOGDSC_LANGUAGE_ID_Attr
public static final int STORECAT_MASTERCATALOG_Attr
public static final int STORECAT_STOREENT_ID_Attr
public static final int STORECGRP_STOREENT_ID_Attr
public static final int OR_Operator
public static final int AND_Operator
public static final int IS_NULL_Operator
public static final int IS_NOT_NULL_Operator
public static final int LIKE_Operator
public static final int LEFT_LIKE_Operator
public static final int RIGHT_LIKE_Operator
public static final int NOT_LIKE_Operator
public static final int NOT_LEFT_LIKE_Operator
public static final int NOT_RIGHT_LIKE_Operator
public static final int EQ_Operator
public static final int GT_Operator
public static final int GE_Operator
public static final int LT_Operator
public static final int LE_Operator
public static final int NE_Operator
public static final int IN_Operator
public static final int NOT_IN_Operator
public static final int NOT_GT_Operator
public static final int NOT_LT_Operator
public static final int GROUP_BY_Operator
public static final int ORDER_BY_Operator
public static final int COUNT_Operator
public static final int ASC_Operator
public static final int DESC_Operator
public static final int MIN_Operator
public static final int MAX_Operator
public static final int SUM_Operator
public static final int AVG_Operator
public static final int UPPER_Function
public static final int GENERIC_QueryType
public static final int CATENTRY_SKU_QueryType
public static final int ANY_QueryType
public static final int ITEM_QueryType
public static final int BOTH_QueryType
public static final int ITEM_CatEntryType
public static final int BUNDLE_CatEntryType
public static final int PACKAGE_CatEntryType
public static final int PRODUCT_CatEntryType
public static final int DYNAMICKIT_CatEntryType
public boolean defaultResultSelection
public boolean isProduct
public boolean isItem
public boolean isBundle
public boolean isPackage
public boolean isDynamicKit
public boolean isAll
public RuleQuery()
public RuleQuery(TradingAgreementAccessBean[] agreements)
RuleQuery(TradingAgreementAccessBean[] agreements, Long userId)
.public RuleQuery(TradingAgreementAccessBean[] agreements, java.lang.Long userId)
agreements
- The trading agreement access bean array to process entitlement.userId
- The user id to process entitlement.public RuleQuery(int inStoreID, TradingAgreementAccessBean[] agreements)
RuleQuery(int inStoreID, TradingAgreementAccessBean[] agreements, Long userId)
.public RuleQuery(int inStoreID, TradingAgreementAccessBean[] agreements, java.lang.Long userId)
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.public RuleQuery(int inStoreID, int inUserID)
inStoreID
- The store id that will be added to search criteria.inUserID
- The user id.public RuleQuery(com.ibm.commerce.search.base.Query q)
q
- A query classpublic RuleQuery(java.util.Vector inStoreIDs, TradingAgreementAccessBean[] agreements)
RuleQuery(Vector inStoreIDs, TradingAgreementAccessBean[] agreements, Long userId)
.public RuleQuery(java.util.Vector inStoreIDs, TradingAgreementAccessBean[] agreements, java.lang.Long userId)
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.public RuleQuery(java.util.Vector inStoreIDs, int inUserID)
inStoreIDs
- Store id collection that will be added to search criteria.inUserID
- The user id.public void addFilterAttribute(int attribute, int operator) throws java.lang.Exception
NOTLIKE
and if NOTLIKE
it will be converted to LIKE.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.java.lang.Exception
public void addFilterAttribute(int attribute, int operator, int function) throws java.lang.Exception
NOTLIKE
.
The attribute, operator, and function parameter values are obtained from the corresponding constants defined within this class.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.java.lang.Exception
public void addFilterAttribute(int attribute, int operator, java.lang.String value) throws java.lang.Exception
NOTLIKE
.
The attribute and operator parameter values are obtained from the corresponding constants defined within this class.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.java.lang.Exception
public void addFilterAttribute(int attribute, int operator, java.lang.String value, int function) throws java.lang.Exception
NOTLIKE
.
The attribute, operator, and function parameter values are obtained from the corresponding constants defined within this class.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.java.lang.Exception
public void addFilterOperand(com.ibm.commerce.search.base.Attribute attr) throws java.lang.Exception
attr
- A WHERE clause predicatejava.lang.Exception
public void addFilterOperand(com.ibm.commerce.search.base.Predicate predicate) throws java.lang.Exception
predicate
- A collection of WHERE clause predicatesjava.lang.Exception
public void addFilterOperator(int operator)
operator
- The static integer constant equivalent of an operator.public void addGlobalPredicate(com.ibm.commerce.search.base.Predicate globalPredicate)
ANDedwith the selectSet/filterSet. Set the globalPredicate variable
globalPredicate
- The global predicate.public void addGroupByAttribute(int attribute) throws java.lang.Exception
attribute
- The integer representing the attribute info class.java.lang.Exception
public void addGroupByAttribute(java.lang.String attribute) throws java.lang.Exception
attribute
- The attribute info class name.java.lang.Exception
public void addOrderByAttribute(int attribute, int operator) throws java.lang.Exception
attribute
- The static integer constant equivalent of a column name.operator
- The operator static integer constant.java.lang.Exception
public void addOrderByAttribute(java.lang.String attribute, java.lang.String operator) throws java.lang.Exception
attribute
- The string representation of a column name.operator
- The operator string representation.java.lang.Exception
public void addOrderByAttribute1(int attribute, int operator) throws java.lang.Exception
attribute
- The static integer constant equivalent of a column name.operator
- The operator static integer constant.java.lang.Exception
public void addResultAttribute(int resultAttribute) throws java.lang.Exception
resultAttribute
- The result to be added.java.lang.Exception
public void addResultAttribute(java.lang.String attribute) throws java.lang.Exception
attribute
- The result to be added.java.lang.Exception
public void addResultAttribute(java.lang.String attribute, java.lang.String operator) throws java.lang.Exception
attribute
- The string representation of a column name.operator
- The operator string representation.java.lang.Exception
public void addRule()
public void addRule(int aQueryType)
addRule()
.aQueryType
- The type of result to be retrieved by the query. The search interface can retrieve only Products, only Items or Both.public void addSelectAttribute(int attribute, int operator) throws java.lang.Exception
attribute
- The static integer constant equivalent of a column name.operator
- The static integer constant equivalent of an operator.java.lang.Exception
public void addSelectAttribute(int attribute, int operator, int function) throws java.lang.Exception
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.java.lang.Exception
public void addSelectAttribute(int attribute, int operator, java.lang.String value) throws java.lang.Exception
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.java.lang.Exception
public void addSelectAttribute(int attribute, int operator, java.lang.String value, int function) throws java.lang.Exception
NOTLIKE
.
The attribute, operator, and function parameter values are obtained from the corresponding constants defined within this class.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.java.lang.Exception
public void addSelectAttribute(java.lang.String attribute, int operator, java.lang.String value) throws java.lang.Exception
addSelectAttribute(int attribute, int operator, String value)
.AttrValue
column.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.java.lang.Exception
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
AttrValue
column.
The operator parameter values are obtained from the corresponding constants defined within this class.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.java.lang.Exception
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
AttrValue
column.
The operator and function parameter values are obtained from the corresponding constants defined within this class.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 functionjava.lang.Exception
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
addSelectAttribute(String attribute, int operator, String value, int attrValueType, String languageId, String prodType, int function)
.AttrValue
column.
The operator parameter values are obtained from the corresponding constants defined within this class.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.java.lang.Exception
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
addSelectAttribute(String attribute, int operator, String value, int attrValueType, String languageId, String prodType, int function)
.AttrValue
column.
The operator and function parameter values are obtained from the corresponding constants defined within this class.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 functionjava.lang.Exception
public void addSelectOperand(com.ibm.commerce.search.base.Attribute attr) throws java.lang.Exception
attr
- A WHERE clause predicatejava.lang.Exception
public void addSelectOperand(com.ibm.commerce.search.base.Predicate predicate) throws java.lang.Exception
predicate
- A collection of predicates.java.lang.Exception
public void addSelectOperator(int operator)
operator
- The static integer constant equivalent of an operator.public java.util.Vector execute() throws java.lang.Exception
catentry
ids that satisfy the query.catentry
ids.java.lang.Exception
public java.util.Vector execute(com.ibm.commerce.base.objects.Cursor aCursor) throws java.lang.Exception
catentry
id between a start value and end value specified in the cursor object.aCursor
- The cursor object.catentry
ids between a start value and end value specified in the cursor object.java.lang.Exception
public com.ibm.commerce.dynacache.commands.CachedCollectionEnumeration execute(int aInitialIndex, com.ibm.commerce.dynacache.commands.AbstractDistributedMapCache aDistributedMapCache) throws java.lang.Exception
catentry
id.aInitialIndex
- the initial zero based index for the returned enumeration.aDistributedMapCache
- used to do the caching.catentry
idsjava.lang.Exception
public java.util.Vector findStorePaths(int sid) throws java.lang.Exception
sid
- The store id.java.lang.Exception
public java.lang.Integer getCatgrpSchemaType()
catgroup
schema type.catgroup
schema type.public java.lang.Long getLongUserId()
public com.ibm.commerce.search.base.Query getMcQuery()
public com.ibm.commerce.search.base.Predicate getPredicate() throws java.lang.Exception
java.lang.Exception
public int getQueryType()
public java.lang.Integer getRASchemaType()
public java.util.Vector getResultSet()
public int getSelectivitySize()
public java.util.Vector getSourceTables()
public java.lang.Integer getStoreID()
public java.util.Vector getStoreIDs()
public java.lang.Integer getUserID()
public void initialize()
public boolean isPriceSummary()
public void reset()
public void resetQueryType()
public void setAgreements(TradingAgreementAccessBean[] newAgreements)
newAgreements
- com.ibm.commerce.contract.objects.TradingAgreementAccessBean[]public void setCatgrpSchemaType(java.lang.Integer newCatgrpSchemaType)
newCatgrpSchemaType
- java.lang.Integerpublic void setDefaultResultSelection()
public void setDistinct()
public void setDistinct(boolean distinctFlag)
distinctFlag
- true to set distinct, false otherwise.public void setLongUserId(java.lang.Long newLongUserId)
RuleQuery(TradingAgreementAccessBean[] agreements, Long userId)
, RuleQuery(int inStoreID, TradingAgreementAccessBean[] agreements, Long userId)
, RuleQuery(int inStoreID, int inUserID)
.newLongUserId
- java.lang.Longpublic void setRASchemaType(java.lang.Integer newRASchemaType)
newRASchemaType
- java.lang.Integerpublic void setSelectivitySize(int newSelectivitySize)
newSelectivitySize
- The new selectivity size.public void setStoreID(java.lang.Integer newStoreID)
newStoreID
- The new store id.public void setStoreIDs(java.util.Vector newStoreIDs)
newStoreIDs
- The new store ids.public void setUserID(int newUserID)
RuleQuery(TradingAgreementAccessBean[] agreements, Long userId)
, RuleQuery(int inStoreID, TradingAgreementAccessBean[] agreements, Long userId)
, RuleQuery(int inStoreID, int inUserID)
.newUserID
- The new user id.public java.lang.String toString()
toString
in class java.lang.Object
public java.util.Locale getLocale()
public void setLocale(java.util.Locale locale)
locale
- the locale.public com.ibm.commerce.search.base.Predicate getOptCatgrpPredicate()
Predicate
optCatgrpPredicate to be used in the query.Predicate
optCatgrpPredicate to be used in the query.public void setOptCatgrpPredicate(com.ibm.commerce.search.base.Predicate anOptCatgrpPredicate)
Predicate
optCatgrpPredicate to be used in the query.anOptCatgrpPredicate
- a Predicate
optCatgrpPredicate object.