java.lang.Object | +--com.ibm.commerce.beans.InputDataBeanImpl | +--com.ibm.commerce.beans.SmartDataBeanImpl | +--com.ibm.commerce.tools.contract.beans.ProductSearchListDataBean
Find Catalog Entries or Categories in a store
Field Summary | |
---|---|
protected
java.lang.String |
_searchType |
static java.lang.String |
CATENTRY_TYPE_BUNDLE Catentry type constants |
static java.lang.String |
CATENTRY_TYPE_DYNAMIC_KIT Catentry type constants |
static java.lang.String |
CATENTRY_TYPE_ITEM Catentry type constants |
static java.lang.String |
CATENTRY_TYPE_PACKAGE Catentry type constants |
static java.lang.String |
CATENTRY_TYPE_PRODUCT Catentry type constants |
static java.lang.String |
ORDER_BY_CATEGORY_IDENTIFIER Order by constants |
static java.lang.String |
ORDER_BY_CATEGORY_NAME Order by constants |
static java.lang.String |
ORDER_BY_CATEGORY_SHORTDESCRIPTION Order by constants |
static java.lang.String |
ORDER_BY_PRODUCT_CODE Order by constants |
static java.lang.String |
ORDER_BY_PRODUCT_NAME Order by constants |
static java.lang.String |
ORDER_BY_SHORTDESCRIPTION Order by constants |
static java.lang.String |
TYPE_LIKE_CASE_SENSITIVE Pattern match type constants |
static java.lang.String |
TYPE_LIKE_IGNORE_CASE Pattern match type constants |
static java.lang.String |
TYPE_MATCH_CASE_SENSITIVE Pattern match type constants |
static java.lang.String |
TYPE_MATCH_IGNORE_CASE Pattern match type constants |
Fields inherited from class com.ibm.commerce.beans. SmartDataBeanImpl |
commandContext,
COPYRIGHT |
Fields inherited from class com.ibm.commerce.beans. InputDataBeanImpl |
requestProperties |
Fields inherited from interface com.ibm.commerce.beans. DataBean |
emptyString |
Constructor Summary | |
---|---|
ProductSearchListDataBean() Create a ProductSearchListDataBean |
Method Summary | |
---|---|
static java.lang.String |
escapeSQLstring(java.lang.String result) Receives a string to be used in a SQL command and inserts any necessary escape characters. |
java.lang.String |
getCatalogEntryType() Get the catalog entry type |
java.lang.String |
getCatalogID() Get the store identifier |
ProductSearchDataBean[] |
getCatalogList() Get the list of entries that were found |
ProductSearchDataBean |
getCatalogListData(int index) Get a specific entry that was found |
java.lang.String |
getDefaultLanguageID() Get the language identifier for the language in which to search |
java.lang.String |
getIndexBegin() Get the beginning index into the search results |
java.lang.String |
getIndexEnd() Get the end index into the search results |
java.lang.String |
getLanguageID() Get the language identifier for the language in which to search |
int |
getListSize() Get the size of the search results list |
java.lang.String |
getMemberID() Get the member identifer |
java.lang.String |
getName() Get the name of the item to search for |
java.lang.String |
getNameLike() Get the type of name search |
java.lang.String |
getOrderBy() Get the parameter to order the results by |
java.lang.String |
getPartNumber() Get the SKU to search for |
java.lang.String |
getPartNumberLike() Get the type of SKU search |
TypedProperty |
getRequestProperties() Get the request properties |
int |
getResultSetSize() Get the total number of entries found |
java.lang.String |
getShortDescription() Get the short description to search for |
java.lang.String |
getShortDescriptionLike() Get the type of short description search |
java.lang.String |
getStoreEntityIdWhereClause(java.lang.Integer storeId,
java.lang.String prefix) Get the where clause that includes the stores on the store path |
java.lang.String |
getStoreID() Get the store identifier |
static java.lang.String |
getUpperCaseFunction() Insert the method's description here. |
void |
populate() Populate the Category or Catalog Entry data |
void |
setCatalogEntryType(java.lang.String catEntType) Set the type of catalog entry identifier search |
void |
setCatalogID(java.lang.String newCatalogID) Set the catalog identifier |
void |
setCatalogList(java.util.Vector newCatalogList) Set the list of results found |
void |
setIndexBegin(java.lang.String newIndexBegin) Set the starting index of the result items |
void |
setIndexEnd(java.lang.String newIndexEnd) Set the end index of the result items |
void |
setLanguageID(java.lang.String newLanguageID) Set the language identifier in which to search |
void |
setMemberID(java.lang.String newMemberID) Set the member identifier |
void |
setName(java.lang.String newName) Set the name to search for |
void |
setNameLike(java.lang.String newNameLike) Set the type of name search |
void |
setOrderBy(java.lang.String newOrderBy) Set the parameter in which to sort by |
void |
setPartNumber(java.lang.String newPartNumber) Set the SKU to search for |
void |
setPartNumberLike(java.lang.String newPartNumberLike) Set the type of SKU search |
void |
setRequestProperties(
TypedProperty param) Set the request properties |
void |
setResultSetSize(int newResultSetSize) Set the total number of results |
void |
setSearchType(java.lang.String searchType) Set the type of search to perform |
void |
setShortDescription(java.lang.String newShortDescription) Set the short description to search for |
void |
setShortDescriptionLike(java.lang.String newShortDescriptionLike) Set the type of short description search |
void |
setStoreID(java.lang.String newStoreID) Set the store identifier |
Methods inherited from class com.ibm.commerce.beans. SmartDataBeanImpl |
fulfills,
getCommandContext,
getResources,
setCommandContext |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll,
toString, wait, wait, wait |
Field Detail |
---|
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_SHORTDESCRIPTION
public static final java.lang.String ORDER_BY_CATEGORY_NAME
public static final java.lang.String ORDER_BY_CATEGORY_SHORTDESCRIPTION
public static final java.lang.String ORDER_BY_CATEGORY_IDENTIFIER
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 static final java.lang.String CATENTRY_TYPE_PRODUCT
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_BUNDLE
public static final java.lang.String CATENTRY_TYPE_DYNAMIC_KIT
protected java.lang.String _searchType
Constructor Detail |
---|
public ProductSearchListDataBean()
Method Detail |
---|
public static java.lang.String escapeSQLstring(java.lang.String result)
Behaviour:
\ is inserted before % _ ' and \result
- The string to be formatted for SQL.public java.lang.String getCatalogEntryType()
public java.lang.String getCatalogID()
public ProductSearchDataBean[] getCatalogList()
public ProductSearchDataBean getCatalogListData(int index) throws java.lang.ArrayIndexOutOfBoundsException
java.lang.ArrayIndexOutOfBoundsException
public java.lang.String getDefaultLanguageID() throws java.lang.Exception
java.lang.Exception
public java.lang.String getIndexBegin()
public java.lang.String getIndexEnd()
public java.lang.String getLanguageID() throws java.lang.Exception
java.lang.Exception
public int getListSize()
public java.lang.String getMemberID()
public java.lang.String getName()
public java.lang.String getNameLike()
public java.lang.String getOrderBy()
public java.lang.String getPartNumber()
public java.lang.String getPartNumberLike()
public TypedProperty getRequestProperties()
getRequestProperties
in interface
InputDataBean
getRequestProperties
in class
InputDataBeanImpl
public int getResultSetSize()
public java.lang.String getShortDescription()
public java.lang.String getShortDescriptionLike()
public java.lang.String getStoreID()
public static final java.lang.String getUpperCaseFunction()
public void populate()
populate
in interface
SmartDataBean
populate
in class
SmartDataBeanImpl
public void setCatalogEntryType(java.lang.String catEntType)
public void setCatalogID(java.lang.String newCatalogID)
public void setCatalogList(java.util.Vector newCatalogList)
newCatalogList
- java.util.Vectorpublic void setIndexBegin(java.lang.String newIndexBegin)
newIndexBegin
- java.lang.Stringpublic void setIndexEnd(java.lang.String newIndexEnd)
newIndexEnd
- java.lang.Stringpublic void setLanguageID(java.lang.String newLanguageID)
public void setMemberID(java.lang.String newMemberID)
newMemberID
- java.lang.Stringpublic void setName(java.lang.String newName)
newName
- java.lang.Stringpublic void setNameLike(java.lang.String newNameLike)
newNameLike
- java.lang.Stringpublic void setOrderBy(java.lang.String newOrderBy)
newOrderBy
- java.lang.Stringpublic void setPartNumber(java.lang.String newPartNumber)
newPartNumber
- java.lang.Stringpublic void setPartNumberLike(java.lang.String newPartNumberLike)
newPartNumberLike
- java.lang.Stringpublic void setRequestProperties(TypedProperty param)
setRequestProperties
in interface
InputDataBean
setRequestProperties
in class
InputDataBeanImpl
param
-
com.ibm.commerce.datatype.TypedPropertypublic void setResultSetSize(int newResultSetSize)
newResultSetSize
- intpublic void setSearchType(java.lang.String searchType)
searchType
- Stringpublic void setShortDescription(java.lang.String newShortDescription)
newShortDescription
- java.lang.Stringpublic void setShortDescriptionLike(java.lang.String newShortDescriptionLike)
newShortDescriptionLike
- java.lang.Stringpublic void setStoreID(java.lang.String newStoreID)
newStoreID
- java.lang.Stringpublic java.lang.String getStoreEntityIdWhereClause(java.lang.Integer storeId, java.lang.String prefix)
storeId
- java.lang.Integerprefix
- java.lang.String