java.lang.Object | +--com.ibm.commerce.beans.InputDataBeanImpl | +--com.ibm.commerce.beans.SmartDataBeanImpl | +--com.ibm.commerce.search.beans.SearchBaseDataBean | +--com.ibm.commerce.search.beans.CatalogSearchListDataBean
This bean is used to retrieve catalog identifier information from master catalog based on input search criteria. This bean extends CatalogSearchBaseDataBean. The search criteria may be input using a JSP. List of variables that may be input using JSP are as follows.
Field Summary |
---|
Fields inherited from class com.ibm.commerce.search.beans. SearchBaseDataBean |
aCursor,
beginIndex,
commandContext,
databaseType,
pageSize,
q,
resultCount |
Fields inherited from class com.ibm.commerce.beans. SmartDataBeanImpl |
COPYRIGHT |
Fields inherited from class com.ibm.commerce.beans. InputDataBeanImpl |
requestProperties |
Fields inherited from interface com.ibm.commerce.beans. DataBean |
emptyString |
Constructor Summary | |
---|---|
CatalogSearchListDataBean() CatalogSearchListDataBean constructor comment. |
Method Summary | |
---|---|
protected
Predicate |
buildBooleanPredicate(java.lang.String aTerm,
java.lang.String aOperator, java.lang.String aType,
java.lang.String caseSensitive, int attrIdentity) Formulate a search predicate, to search on a Varchar or Char column. |
protected
void |
execute() Calls the search interface to query the database. |
java.lang.String |
getAdmnDesc() A user can choose either 'like' or 'equal' as search operators. |
java.lang.String |
getAdmnDescCaseSensitive() A user can choose case sensitive or case insensitive search. |
java.lang.String |
getAdmnDescOperator() A user can choose either 'like' or 'equal' as search operators. |
java.lang.String |
getAdmnDescType() A user can specify three types of search criteria All, Any, Exact Phrase. |
java.lang.Integer |
getCatalogType() The value of this variable is used to search on navigational or master catalog. |
java.lang.String |
getDistinct() Defines SQL distinct qualifier. |
java.lang.String |
getIdentifier() The value of this variable is used in search based on catalog identifier (Catalog.identifier column). |
java.lang.String |
getIdentifierCaseSensitive() Insert the method's description here. |
java.lang.String |
getIdentifierOperator() A user can choose either 'like' or 'equal' as search operators. |
java.lang.String |
getIdentifierType() A user can specify three types of search criteria All, Any, Exact Phrase. |
java.lang.String |
getLangId() The langId to search. |
java.lang.String |
getName() Insert the method's description here. |
java.lang.String |
getNameCaseSensitive() Insert the method's description here. |
java.lang.String |
getNameTermOperator() Insert the method's description here. |
java.lang.String |
getNameType() Insert the method's description here. |
java.lang.String |
getOrderBy1() Result set will be sorted by this attribute. |
java.lang.String |
getOrderByOperator1() Attributes can be sorted by ascending (default) or decending order. |
java.lang.String |
getResultCount() Returns resultCount |
CatalogDataBean[] |
getResultList() Search results as array of CatalogDataBeans from resultSet variable. |
java.lang.String |
getResultName() Column names for building a result set. |
java.util.Vector |
getResultSet() Search results as vector of vectors of strings containing rows with result set columns where first column must be Catalog ids. |
java.util.Vector |
getResultSetName() Search results as vector of vectors of strings containing result set column names. |
java.lang.String |
getShortDesc() The value of this variable is used in search based on catalog shortdescription (Catalogdsc.shortdescription column). |
java.lang.String |
getShortDescCaseSensitive() A user can choose case sensitive or case insensitive search. |
java.lang.String |
getShortDescOperator() A user can choose either 'like' or 'equal' as search operators. |
java.lang.String |
getShortDescType() A user can specify three types of search criteria All, Any, Exact Phrase. |
java.lang.String |
getStoreId() Insert the method's description here. |
java.lang.String |
getStoreIdOperator() Insert the method's description here. |
int |
getUserId() Insert the method's description here. |
protected
void |
initialize() initialize the data bean with command context |
void |
populate() Populate the data bean |
void |
setAdmnDesc(java.lang.String newAdmnDesc) The value of this variable is used in search based on catalog description (Catalog.description column). |
void |
setAdmnDescCaseSensitive(java.lang.String newAdmnDescCaseSensitive) A user can choose case sensitive or case insensitive search. |
void |
setAdmnDescOperator(java.lang.String newAdmnDescOperator) A user can choose either 'like' or 'equal' as search operators. |
void |
setAdmnDescType(java.lang.String newAdmnDescType) A user can specify three types of search criteria All, Any, Exact Phrase. |
void |
setCatalogType(java.lang.Integer newCatalogType) The value of this variable is used to search on navigational or master catalog. |
void |
setDistinct(java.lang.String newDistinct) Defines SQL distinct qualifier. |
void |
setIdentifier(java.lang.String newIdentifier) The value of this variable is used in search based on catalog identifier (Catalog.identifier column). |
void |
setIdentifierCaseSensitive(java.lang.String newIdentifierCaseSensitive) Insert the method's description here. |
void |
setIdentifierOperator(java.lang.String newIdentifierOperator) A user can choose either 'like' or 'equal' as search operators. |
void |
setIdentifierType(java.lang.String newIdentifierType) A user can specify three types of search criteria All, Any, Exact Phrase. |
void |
setLangId(java.lang.String newLangId) The langId to search. |
void |
setName(java.lang.String newName) Insert the method's description here. |
void |
setNameCaseSensitive(java.lang.String newNameCaseSensitive) Insert the method's description here. |
void |
setNameTermOperator(java.lang.String newNameTermOperator) Insert the method's description here. |
void |
setNameType(java.lang.String newNameType) Insert the method's description here. |
protected
void |
setPredefinedAttributes() Use rulequery to build the query predicate. |
void |
setResultCount(java.lang.String newResultCount) Accessor generated by VAJ - do not modify. |
void |
setResultList(
CatalogDataBean[] newResultList) Search results as array of CatalogDataBeans from resultSet variable. |
void |
setResultName(java.lang.String newResultName) Search results as vector of vectors of strings containing result set column names. |
void |
setResultSet(java.util.Vector newResultSet) Search results as vector of vectors of strings containing rows with result set columns where first column must be Catalog ids. |
void |
setResultSetName(java.lang.String newResultName) Search results as vector of vectors of strings containing result set column names. |
void |
setShortDesc(java.lang.String newShortDesc) The value of this variable is used in search based on catalog shortdescription (Catalogdsc.shortdescription column). |
void |
setShortDescCaseSensitive(java.lang.String newShortDescCaseSensitive) A user can choose case sensitive or case insensitive search. |
void |
setShortDescOperator(java.lang.String newShortDescOperator) A user can choose either 'like' or 'equal' as search operators. |
void |
setShortDescType(java.lang.String newShortDescType) A user can specify three types of search criteria All, Any, Exact Phrase. |
void |
setStoreId(java.lang.String newStoreId) Insert the method's description here. |
void |
setStoreIdOperator(java.lang.String newStoreIdOperator) Insert the method's description here. |
void |
setUserId(int newUserId) Insert the method's description here. |
Methods inherited from class com.ibm.commerce.search.beans. SearchBaseDataBean |
getBeginIndex,
getNumericOperator,
getPageSize,
getStringOperator,
isEmpty,
setBeginIndex,
setPageSize |
Methods inherited from class com.ibm.commerce.beans. SmartDataBeanImpl |
fulfills,
getCommandContext,
getResources,
setCommandContext |
Methods inherited from class com.ibm.commerce.beans. InputDataBeanImpl |
getRequestProperties,
setRequestProperties |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll,
toString, wait, wait, wait |
Methods inherited from interface com.ibm.commerce.beans. InputDataBean |
getRequestProperties,
setRequestProperties |
Constructor Detail |
---|
public CatalogSearchListDataBean()
Method Detail |
---|
protected Predicate buildBooleanPredicate(java.lang.String aTerm, java.lang.String aOperator, java.lang.String aType, java.lang.String caseSensitive, int attrIdentity)
aTerm
- The search term (can be EQUAL, LIKE, NOT_LIKE).aOperator
- The search operator (string type operator).aType
- The user can specify three types of search criteria
All, Any, Exact Phrase. The value in this variable is used to store a
user's search criteria. The value must be 'ALL'(for All search
criteria), 'ANY'(for Any search criteria) and 'EXACT'(for Exact
phrase criteria).caseSensitive
- The user can choose case sensitive or case
insensitive search. The value in this variable is used to identify if a search
is case sensitive or not. The value must be either 'yes' (case
sensitive) or 'no' (case insensitive)attrIdentity
- The column to search on.protected void execute()
execute
in class
SearchBaseDataBean
public java.lang.String getAdmnDesc()
public java.lang.String getAdmnDescCaseSensitive()
public java.lang.String getAdmnDescOperator()
public java.lang.String getAdmnDescType()
public java.lang.Integer getCatalogType()
public java.lang.String getDistinct()
public java.lang.String getIdentifier()
public java.lang.String getIdentifierCaseSensitive()
public java.lang.String getIdentifierOperator()
public java.lang.String getIdentifierType()
public java.lang.String getLangId()
public java.lang.String getName()
public java.lang.String getNameCaseSensitive()
public java.lang.String getNameTermOperator()
public java.lang.String getNameType()
public java.lang.String getResultCount()
getResultCount
in class
SearchBaseDataBean
public CatalogDataBean[] getResultList()
public java.lang.String getResultName()
public java.util.Vector getResultSet()
public java.util.Vector getResultSetName()
public java.lang.String getShortDesc()
public java.lang.String getShortDescCaseSensitive()
public java.lang.String getShortDescOperator()
public java.lang.String getShortDescType()
public java.lang.String getStoreId()
public java.lang.String getStoreIdOperator()
public int getUserId()
protected void initialize()
initialize
in class
SearchBaseDataBean
public void populate()
populate
in interface
SmartDataBean
populate
in class
SearchBaseDataBean
public void setAdmnDesc(java.lang.String newAdmnDesc)
newAdmnDesc
- java.lang.Stringpublic void setAdmnDescCaseSensitive(java.lang.String newAdmnDescCaseSensitive)
newAdmnDescCaseSensitive
-
java.lang.Stringpublic void setAdmnDescOperator(java.lang.String newAdmnDescOperator)
newAdmnDescOperator
- java.lang.Stringpublic void setAdmnDescType(java.lang.String newAdmnDescType)
newAdmnDescType
- java.lang.Stringpublic void setCatalogType(java.lang.Integer newCatalogType)
newCatalogType
- java.lang.Integerpublic void setDistinct(java.lang.String newDistinct)
newDistinct
- java.lang.Stringpublic void setIdentifier(java.lang.String newIdentifier)
newIdentifier
- java.lang.Stringpublic void setIdentifierCaseSensitive(java.lang.String newIdentifierCaseSensitive)
newIdentifierCaseSensitive
-
java.lang.Stringpublic void setIdentifierOperator(java.lang.String newIdentifierOperator)
public void setIdentifierType(java.lang.String newIdentifierType)
newIdentifierType
- java.lang.Stringpublic void setLangId(java.lang.String newLangId)
newLangId
- java.lang.Stringpublic void setName(java.lang.String newName)
newName
- java.lang.Stringpublic void setNameCaseSensitive(java.lang.String newNameCaseSensitive)
newNameCaseSensitive
- java.lang.Stringpublic void setNameTermOperator(java.lang.String newNameTermOperator)
newNameTermOperator
- java.lang.Stringpublic void setNameType(java.lang.String newNameType)
newNameType
- java.lang.Stringprotected void setPredefinedAttributes()
setPredefinedAttributes
in class
SearchBaseDataBean
public java.lang.String getOrderBy1()
public java.lang.String getOrderByOperator1()
public void setResultCount(java.lang.String newResultCount)
setResultCount
in class
SearchBaseDataBean
newResultCount
- java.lang.Stringpublic void setResultList(CatalogDataBean[] newResultList)
newResultList
-
com.ibm.commerce.catalog.beans.CatalogDataBean[]public void setResultName(java.lang.String newResultName)
newResultName
- java.lang.Stringpublic void setResultSet(java.util.Vector newResultSet)
newResultSet
- java.util.Vectorpublic void setResultSetName(java.lang.String newResultName)
public void setShortDesc(java.lang.String newShortDesc)
newShortDesc
- java.lang.Stringpublic void setShortDescCaseSensitive(java.lang.String newShortDescCaseSensitive)
newShortDescCaseSensitive
-
java.lang.Stringpublic void setShortDescOperator(java.lang.String newShortDescOperator)
newShortDescOperator
- java.lang.Stringpublic void setShortDescType(java.lang.String newShortDescType)
newShortDescType
- java.lang.Stringpublic void setStoreId(java.lang.String newStoreId)
newStoreId
- java.lang.Stringpublic void setStoreIdOperator(java.lang.String newStoreIdOperator)
newStoreIdOperator
- java.lang.Stringpublic void setUserId(int newUserId)
newUserId
- int