public class CatalogSearchListDataBean extends SearchBaseDataBean
CatalogSearchBaseDataBean
.
The user can enter search criteria using a JSP. A user can enter the following variables using a JSP:
name
(String): The value of this variable is used in search based on catalog name (Catalogdsc.name column).
nameCaseSensitive
(String) : A 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 search) or 'no'(case insensitive search).
nameOperator
(String) : A user can choose either 'like' or 'equal' as search operators. The value in this variable is used to store a user's choice. The value must be either 'LIKE'(for like operator) or 'EQUAL'(for equal operator).
nameType
(String) : A 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).
shortDesc
(String): The value of this variable is used in search based on catalog shortdescription
(Catalogdsc.shortdescription column).
shortDescCaseSensitive
(String) : A 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 search) or 'no'(case insensitive search).
shortDescOperator
(String) : A user can choose either 'like' or 'equal' as search operators. The value in this variable is used to store a user's choice. The value must be either 'LIKE'(for like operator) or 'EQUAL'(for equal operator).
shortDescType
(String) : A 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).
admnDesc
(String): The value of this variable is used in search based on catalog description (Catalog.description column).
admnDescCaseSensitive
(String) : A 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 search) or 'no'(case insensitive search).
admnDescOperator
(String) : A user can choose either 'like' or 'equal' as search operators. The value in this variable is used to store a user's choice. The value must be either 'LIKE'(for like operator) or 'EQUAL'(for equal operator).
admnDescType
(String) : A 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).
storeId
(String) : A user can specify the store to search on. It can be single store or multiple store. In case of multiple store each store has to be delimited by ','.
storeIdOperator
: A user can choose one of the following operators as search operators: =, <, >, !=, <=, >=. The value in this variable is used to store a user's choice. The value must be any one of the following: EQUAL
, 'NOTEQUAL
,' GREATER
, LESS
, GREATER_EQUAL
, LESS_EQUAL
, IN.
identifier
(String): The value of this variable is used in search based on catalog identifier (Catalog.identifier column).
identifierCaseSensitive
(String) : A 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 search) or 'no'(case insensitive search).
identifierOperator
(String) : A user can choose either 'like' or 'equal' as search operators. The value in this variable is used to store a user's choice. The value must be either 'LIKE'(for like operator) or 'EQUAL'(for equal operator).
identifierType
(String) : A 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).
catalogType
(Integer) : The value of this variable is used to search on navigational or master catalog. Possible values are MASTER_CATALOG
or NAVIGATIONAL_CATALOG
. By default the value is MASTER_CATALOG.
catalogSearchDB.setName("Fall Fashions"); catalogSearchDB.setNameCaseSensitive("true"); catalogSearchDB.setNameTermOperator("EQUAL"); catalogSearchDB.setNameType("STRING");
ALL, ALL_CATALOG, ALL_CATEGORIES, ALLWORDS, ANYWORDS, ATTRVALUE_FLOATVALUE, ATTRVALUE_INTEGERVALUE, ATTRVALUE_STRINGVALUE, BOTH, CASE_SENSITIVE, CATGPENREL_BOTH_SCHEMA_TYPE, CATGPENREL_PRODUCT_SCHEMA_TYPE, DISTINCT_RESULT, EXACTPHRASE, ITEM, LISTPRICE_ON, MASTER_CATALOG, OPERATOR_EQUAL, OPERATOR_GREATER, OPERATOR_GREATER_EQUAL, OPERATOR_IN, OPERATOR_LEFT_LIKE, OPERATOR_LESS, OPERATOR_LESS_EQUAL, OPERATOR_LIKE, OPERATOR_NOT_EQUAL, OPERATOR_NOT_LIKE, OPERATOR_RIGHT_LIKE, PRODUCT, SEARCH_IN_CATEGORYNAME, SEARCH_IN_CATEGORYNAME_AND_DESCRIPTIONS, SEARCH_IN_CATEGORYNAME_AND_SHORT_DESCRIPTION, SEARCH_IN_KEYWORD, SEARCH_IN_PRODUCTNAME, SEARCH_IN_PRODUCTNAME_AND_DESCRIPTIONS, SEARCH_IN_PRODUCTNAME_AND_SHORT_DESCRIPTION
emptyString
Constructor and Description |
---|
CatalogSearchListDataBean()
CatalogSearchListDataBean constructor comment.
|
Modifier and Type | Method and Description |
---|---|
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()
Returns
identifierCaseSensitive . |
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()
Returns name.
|
java.lang.String |
getNameCaseSensitive()
Returns
nameCaseSensitive . |
java.lang.String |
getNameTermOperator()
Returns
nameTermOperator . |
java.lang.String |
getNameType()
Returns
nameType . |
java.lang.String |
getOrderBy1()
Result set will be sorted by this attribute.
|
java.lang.String |
getOrderByOperator1()
Attributes can be sorted by ascending (default) or descending 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()
Returns storeId.
|
java.lang.String |
getStoreIdOperator()
Returns
storeIdOperator . |
int |
getUserId()
Returns userId.
|
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)
To set
identifierCaseSensitive . |
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)
To set name.
|
void |
setNameCaseSensitive(java.lang.String newNameCaseSensitive)
To set
nameCaseSensitive . |
void |
setNameTermOperator(java.lang.String newNameTermOperator)
To set
nameTermOperator . |
void |
setNameType(java.lang.String newNameType)
To set
nameType . |
void |
setResultCount(java.lang.String newResultCount)
To set resultCount.
|
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)
To set storeId.
|
void |
setStoreIdOperator(java.lang.String newStoreIdOperator)
To set
storeIdOperator . |
void |
setUserId(int newUserId)
To set userId.
|
getBeginIndex, getCurrentPageNumber, getEndIndex, getExceededPageSize, getLocale, getPageSize, getResultSetSize, getTotalNumberOfResultSetPages, isNextPageExists, isPreviousPageExists, isResultSetEmpty, setAcceleratorFlag, setBeginIndex, setExceededPageSize, setLocale, setPageSize
fulfills, getCommandContext, getHttpRequest, getHttpResponse, getResources, getViewCommandContext, setCommandContext, setHttpRequest, setHttpResponse, setViewCommandContext
getRequestProperties, setRequestProperties
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getRequestProperties, setRequestProperties
public CatalogSearchListDataBean()
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()
MASTER_CATALOG
or NAVIGATIONAL_CATALOG
. By default the value is MASTER_CATALOG.public java.lang.String getDistinct()
DISTINCT
value used for the search.public java.lang.String getIdentifier()
public java.lang.String getIdentifierCaseSensitive()
identifierCaseSensitive
.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()
nameCaseSensitive
.public java.lang.String getNameTermOperator()
nameTermOperator
.public java.lang.String getNameType()
nameType
.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()
shortdescription
(Catalogdsc.shortdescription column).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()
storeIdOperator
.public int getUserId()
public void populate()
populate
in interface SmartDataBean
populate
in class SearchBaseDataBean
public void setAdmnDesc(java.lang.String newAdmnDesc)
newAdmnDesc
- java.lang.String. The admin description used in search based on catalog description.public void setAdmnDescCaseSensitive(java.lang.String newAdmnDescCaseSensitive)
newAdmnDescCaseSensitive
- java.lang.String. A value indicating whether the search is case sensitive or not, either 'yes', or 'no'.public void setAdmnDescOperator(java.lang.String newAdmnDescOperator)
newAdmnDescOperator
- java.lang.String. The search operator value, either 'like' or 'equal'.public void setAdmnDescType(java.lang.String newAdmnDescType)
newAdmnDescType
- java.lang.String. The search criteria value, either 'ALL', 'ANY', or 'EXACT'.public void setCatalogType(java.lang.Integer newCatalogType)
MASTER_CATALOG
or NAVIGATIONAL_CATALOG
. By default the value is MASTER_CATALOG.newCatalogType
- java.lang.Integer. The type of catalog to be searched. Possible values include the default MASTER_CATALOG
, or NAVIGATIONAL_CATALOG
.public void setDistinct(java.lang.String newDistinct)
newDistinct
- java.lang.String. The SQL distinct qualifier.public void setIdentifier(java.lang.String newIdentifier)
newIdentifier
- java.lang.String. The catalog identifier.public void setIdentifierCaseSensitive(java.lang.String newIdentifierCaseSensitive)
identifierCaseSensitive
.newIdentifierCaseSensitive
- java.lang.String. The case sensitive status of the new identifier.public void setIdentifierOperator(java.lang.String newIdentifierOperator)
newIdentifierTermOperator
- java.lang.String. The identifier term operator, either 'like', or 'equal'.public void setIdentifierType(java.lang.String newIdentifierType)
newIdentifierType
- java.lang.String. The search criteria for the identifier, either 'ALL', 'ANY', or 'EXACT'.public void setLangId(java.lang.String newLangId)
newLangId
- java.lang.String. The language ID used in the search.public void setName(java.lang.String newName)
newName
- java.lang.String. The name used in the search.public void setNameCaseSensitive(java.lang.String newNameCaseSensitive)
nameCaseSensitive
.newNameCaseSensitive
- java.lang.String. The case sensitive status for the name.public void setNameTermOperator(java.lang.String newNameTermOperator)
nameTermOperator
.newNameTermOperator
- java.lang.String. The operator used for the name, either 'like' or 'equal'public void setNameType(java.lang.String newNameType)
nameType
.newNameType
- java.lang.String. The name type used in the search.public java.lang.String getOrderBy1()
public java.lang.String getOrderByOperator1()
public void setResultCount(java.lang.String newResultCount)
setResultCount
in class SearchBaseDataBean
newResultCount
- java.lang.String. The result count for the search.public void setResultList(CatalogDataBean[] newResultList)
newResultList
- com.ibm.commerce.catalog.beans.CatalogDataBean[]. The result list array from the search.public void setResultName(java.lang.String newResultName)
newResultName
- java.lang.String. The result name.public void setResultSet(java.util.Vector newResultSet)
newResultSet
- java.util.Vector. A vector of vectors of strings containing rows with result set columns.public void setResultSetName(java.lang.String newResultName)
setResultSetName
- java.lang.String. A vector of vectors of strings containing result set column names.public void setShortDesc(java.lang.String newShortDesc)
shortdescription
(Catalogdsc.shortdescription column).newShortDesc
- java.lang.String. The short description used for the search.public void setShortDescCaseSensitive(java.lang.String newShortDescCaseSensitive)
newShortDescCaseSensitive
- java.lang.String. The case sensitive status used for the short description in the search.public void setShortDescOperator(java.lang.String newShortDescOperator)
newShortDescOperator
- java.lang.String. The operator for the short description, either 'like' or 'equal'.public void setShortDescType(java.lang.String newShortDescType)
newShortDescType
- java.lang.String. The search criteria for the short description, either 'ALL', 'ANY', or 'EXACT'.public void setStoreId(java.lang.String newStoreId)
newStoreId
- java.lang.String. The store ID.public void setStoreIdOperator(java.lang.String newStoreIdOperator)
storeIdOperator
.newStoreIdOperator
- java.lang.String. The store ID operator.public void setUserId(int newUserId)
newUserId
- int. The user ID.