public class CatalogSearchListDataBean
extends com.ibm.commerce.tools.util.CommonSearchHelperBean
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CATENTRY_TYPE_BUNDLE
Values of the catalog entry type, for example: Product, Item, Package, and so on.
|
static java.lang.String |
CATENTRY_TYPE_DYNAMIC_KIT
Values of the catalog entry type, for example: Product, Item, Package, and so on.
|
static java.lang.String |
CATENTRY_TYPE_ITEM
Values of the catalog entry type, for example: Product, Item, Package, and so on.
|
static java.lang.String |
CATENTRY_TYPE_PACKAGE
Values of the catalog entry type, for example: Product, Item, Package, and so on.
|
static java.lang.String |
CATENTRY_TYPE_PRODUCT
Values of the catalog entry type, for example: Product, Item, Package, and so on.
|
static java.lang.String |
COPYRIGHT
IBM copyright notice field.
|
static java.lang.String |
ORDER_BY_CATEGORY_NAME
Database column on the category tables used in the order by clause of the SQL query to do sorting.
|
static java.lang.String |
ORDER_BY_CATEGORY_PARENT
Database column on the category tables used in the order by clause of the SQL query to do sorting.
|
static java.lang.String |
ORDER_BY_CATEGORY_SHORTDESC
Database column on the category tables used in the order by clause of the SQL query to do sorting.
|
static java.lang.String |
ORDER_BY_PRODUCT_CODE
Database column on the catalog entry tables used in the order by clause of the SQL query to do
sorting.
|
static java.lang.String |
ORDER_BY_PRODUCT_NAME
Database column on the catalog entry tables used in the order by clause of the SQL query to do
sorting.
|
static java.lang.String |
ORDER_BY_PRODUCT_SHORTDESC
Database column on the catalog entry tables used in the order by clause of the SQL query to do
sorting.
|
static java.lang.String |
ORDER_BY_PRODUCT_TYPE
Database column on the catalog entry tables used in the order by clause of the SQL query to do
sorting.
|
static java.lang.String |
SEARCH_TYPE_CATENTRY
Values used to determine the kind of search it's performing, either catalog entry or category.
|
static java.lang.String |
SEARCH_TYPE_CATGROUP
Values used to determine the kind of search it's performing, either catalog entry or category.
|
static java.lang.String |
TYPE_LIKE_CASE_SENSITIVE
Values of the search type for each criteria.
|
static java.lang.String |
TYPE_LIKE_IGNORE_CASE
Values of the search type for each criteria.
|
static java.lang.String |
TYPE_MATCH_CASE_SENSITIVE
Values of the search type for each criteria.
|
static java.lang.String |
TYPE_MATCH_IGNORE_CASE
Values of the search type for each criteria.
|
Constructor and Description |
---|
CatalogSearchListDataBean()
Constructor for CatalogSearchListDataBean.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
buildQuery()
Constructs the SQL query.
|
void |
buildResultDataBean(java.util.Vector resultVector)
Constructs the list of result data beans.
|
CatalogSearchDataBean[] |
getCatalogList()
Returns the list of data beans found from the search or list, represented by an array of
CatalogSearchDataBean object. |
CatalogSearchDataBean |
getCatalogListData(int index)
Returns the specific data bean at the passed index within the array of data beans returned,
represented by a
CatalogSearchDataBean object. |
java.lang.String |
getCatentryBuyable()
Gets the buyable flag of catalog entry that is being searched against.
|
java.lang.String |
getCatentryPublished()
Gets the published flag of catalog entry that is being searched against.
|
java.lang.String |
getCatentryType()
Gets the type of catalog entry that is being searched against, can be either all types of
catalog entry, or items only.
|
java.lang.String |
getCatgroupPublished()
Gets the published flag of catalog group that is being searched against.
|
java.lang.String |
getOrderby()
Gets the parameter that is used to order the results in the SQL query.
|
java.lang.String |
getSearchType()
Gets the type of search to be performed, which identifies whether this search logic is
used to search for category or catalog entry.
|
java.lang.String |
getSrName()
Gets the name of the item to search for, this is the value of the name criteria.
|
java.lang.String |
getSrNameType()
Gets the type of search that is being performed to the name criteria.
|
java.lang.String |
getSrPartNumber()
Gets the SKU of the item to search for, this is the value of the SKU criteria.
|
java.lang.String |
getSrPartNumberType()
Gets the type of search that is being performed to the SKU criteria.
|
java.lang.String |
getSrShortDescription()
Gets the short description of the item to search for, this is the value of the short
description criteria.
|
java.lang.String |
getSrShortDescriptionType()
Gets the type of search that is being performed to the short description criteria.
|
void |
setCatalogList(java.util.Vector newCatalogList)
Sets the list of data beans found from the search or list.
|
void |
setCatentryBuyable(java.lang.String newCatentryBuyable)
Sets the buyable flag of catalog entry that is being searched against.
|
void |
setCatentryPublished(java.lang.String newCatentryPublished)
Sets the published flag of catalog entry that is being searched against.
|
void |
setCatentryType(java.lang.String newCatentryType)
Sets the type of catalog entry that is being searched against, can be either all types of
catalog entry, or items only.
|
void |
setCatgroupPublished(java.lang.String newCatgroupPublished)
Sets the published flag of catalog group that is being searched against.
|
void |
setOrderby(java.lang.String newOrderby)
Sets the parameter that is used to order the results in the SQL query.
|
void |
setSearchType(java.lang.String newSearchType)
Sets the type of search to be performed, which identifies whether this search logic is
used to search for category or catalog entry.
|
void |
setSrName(java.lang.String newSrName)
Sets the name of the item to search for, this is the value of the name criteria.
|
void |
setSrNameType(java.lang.String newSrNameType)
Sets the type of search that is being performed to the name criteria.
|
void |
setSrPartNumber(java.lang.String newSrPartNumber)
Sets the SKU of the item to search for, this is the value of the SKU criteria.
|
void |
setSrPartNumberType(java.lang.String newSrPartNumberType)
Sets the type of search that is being performed to the SKU criteria.
|
void |
setSrShortDescription(java.lang.String newSrShortDescription)
Sets the short description of the item to search for, this is the value of the short
description criteria.
|
void |
setSrShortDescriptionType(java.lang.String newSrShortDescriptionType)
Sets the type of search that is being performed to the short description criteria.
|
escapeSQLstring, getDefaultLanguageId, getIndexBegin, getIndexEnd, getLanguageId, getListSize, getResultList, getResultSetSize, getStoreId, getStoreIds, getStoreIdsInEntityType, getStoreRelType, getUpperCaseFunction, getUseCursor, populate, setIndexBegin, setIndexEnd, setLanguageId, setResultList, setResultSetSize, setStoreId, setStoreIds, setStoreIdsInEntityType, setStoreRelType, setUseCursor
fulfills, getCommandContext, getHttpRequest, getHttpResponse, getResources, getViewCommandContext, setCommandContext, setHttpRequest, setHttpResponse, setViewCommandContext
getRequestProperties, setRequestProperties
public static final java.lang.String CATENTRY_TYPE_BUNDLE
public static final java.lang.String CATENTRY_TYPE_DYNAMIC_KIT
public static final java.lang.String CATENTRY_TYPE_ITEM
public static final java.lang.String CATENTRY_TYPE_PACKAGE
public static final java.lang.String CATENTRY_TYPE_PRODUCT
public static final java.lang.String COPYRIGHT
public static final java.lang.String ORDER_BY_CATEGORY_NAME
public static final java.lang.String ORDER_BY_CATEGORY_PARENT
public static final java.lang.String ORDER_BY_CATEGORY_SHORTDESC
public static final java.lang.String ORDER_BY_PRODUCT_CODE
public static final java.lang.String ORDER_BY_PRODUCT_NAME
public static final java.lang.String ORDER_BY_PRODUCT_SHORTDESC
public static final java.lang.String ORDER_BY_PRODUCT_TYPE
public static final java.lang.String SEARCH_TYPE_CATENTRY
public static final java.lang.String SEARCH_TYPE_CATGROUP
public static final java.lang.String TYPE_LIKE_CASE_SENSITIVE
public static final java.lang.String TYPE_LIKE_IGNORE_CASE
public static final java.lang.String TYPE_MATCH_CASE_SENSITIVE
public static final java.lang.String TYPE_MATCH_IGNORE_CASE
public CatalogSearchListDataBean()
public java.lang.String buildQuery() throws java.lang.Exception
com.ibm.commerce.tools.util.CommonSearchHelperBean
and be called by the populate()
method found in the com.ibm.commerce.tools.util.CommonSearchHelperBean
.
buildQuery
in class com.ibm.commerce.tools.util.CommonSearchHelperBean
java.lang.Exception
- Thrown when an exception is encountered whether constructing the query.public void buildResultDataBean(java.util.Vector resultVector)
com.ibm.commerce.tools.util.CommonSearchHelperBean
.buildResultDataBean
in class com.ibm.commerce.tools.util.CommonSearchHelperBean
resultVector
- The result vector returned from the query execution.public CatalogSearchDataBean[] getCatalogList()
CatalogSearchDataBean
object. These are data beans the hold a returned row's
data. For each row returned it will have its own data bean.public CatalogSearchDataBean getCatalogListData(int index) throws java.lang.ArrayIndexOutOfBoundsException
CatalogSearchDataBean
object. If the index is larger than
the size of the array, an ArrayIndexOutOfBoundsException
is thrown.index
- The index of the result array.CatalogSearchDataBean
object.java.lang.ArrayIndexOutOfBoundsException
- Thrown when access an array with an out of bound index.public java.lang.String getCatentryBuyable()
public java.lang.String getCatentryPublished()
public java.lang.String getCatentryType()
public java.lang.String getCatgroupPublished()
public java.lang.String getOrderby()
public java.lang.String getSearchType()
public java.lang.String getSrName()
public java.lang.String getSrNameType()
public java.lang.String getSrPartNumber()
public java.lang.String getSrPartNumberType()
public java.lang.String getSrShortDescription()
public java.lang.String getSrShortDescriptionType()
public void setCatalogList(java.util.Vector newCatalogList)
newCatalogList
- List of data beans that represents the search result list.public void setCatentryBuyable(java.lang.String newCatentryBuyable)
newCatentryBuyable
- The buyable flag of catalog entry.public void setCatentryPublished(java.lang.String newCatentryPublished)
newCatentryPublished
- The published flag of catalog entry.public void setCatentryType(java.lang.String newCatentryType)
newCatentryType
- Type of catalog entry.public void setCatgroupPublished(java.lang.String newCatgroupPublished)
newCatgroupPublished
- The published flag of catalog group.public void setOrderby(java.lang.String newOrderby)
newOrderby
- Order by value used in the SQL query.public void setSearchType(java.lang.String newSearchType)
newSearchType
- The type of search to be performed.public void setSrName(java.lang.String newSrName)
newSrName
- Name of the item.public void setSrNameType(java.lang.String newSrNameType)
newSrNameType
- Type of search on name criteria.public void setSrPartNumber(java.lang.String newSrPartNumber)
newSrPartNumber
- SKU of the item.public void setSrPartNumberType(java.lang.String newSrPartNumberType)
newSrPartNumberType
- Type of search on SKU criteria.public void setSrShortDescription(java.lang.String newSrShortDescription)
newSrShortDescription
- Short description of the item.public void setSrShortDescriptionType(java.lang.String newSrShortDescriptionType)
newSrShortDescriptionType
- Type of search on short description criteria.