public class StoreLocatorDataBean
extends com.ibm.commerce.beans.SmartDataBeanImpl
beginIndex
(String): This variable is used for paging the result set. The value must be the index of the first result row in a page.
mode
(String): This variable is used to define the type of search desired. Value of '0' means search by products, value of '1' means search by store category.
pageSize
(String): This variable is used for paging the result set. The value is the maximum number of rows to be displayed per page.
searchStores
(String): This variable is used to determine the stores that need to be searched. A aalue of '0' means search all stores regardless of state. A value of '1' means stores only stores that are in open state. And a value of '2' means search stores in opened or closed state.
storeCategoryId
(String): This variable must be provided when searching by store category. Value 'All' means stores in any store category.
categoryType
(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).
categoryTerm
(String): The value of this variable is used in search on category name and/or descriptions (table columns searched: Catgrpdesc.name
, Catgrpdesc.Shortdescription
, Catgrpdesc.Longdescription
).
categoryTermScope
(Integer) : A user can restrict the scope (of 'search term'/ 'filter term' search) to name; name and short description; or name, short description and long description. The value in this variable is used to store a user's choice. The value must be 1 (for name and short description), or 2 (for name only), or 3 (for name, short description and long description).
isBundle
(boolean): Set this to false if bundle ids must be returned, by default it is false.
isItem
(boolean): Set this to false if item ids must be returned, by default it is false.
isPackage
(boolean): Set this to true if package ids must be returned, by default it is false.
isProduct
(boolean): Set this to true if product ids must be returned, by default it is false.
searchType
(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).
searchTerm
(String) : The value of this variable is used in search on a word (table columns searched: Catentdesc.name
, Catentdesc.Shortdescription
, Catentdesc.Longdescription
).
searchTermScope
(Integer) :A user can restrict the scope of the 'search term' to search for name only, name and short description, or name, short description and long description, or just keyword. The value in this variable is used to store a user's choice. The value must be either 1 (for name and short description), or 2 (for name only), or 3 (for name, short description and long description), or 4 (for keyword).
sku
(String) : The value of this variable is used to search on SKU (table columns searched: Catentry.Sku
).
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ALL_CATEGORIES
Search stores in any store category.
|
static java.lang.String |
ALL_STORES
All stores.
|
static java.lang.String |
CATALOG_RESOURCE
Catalog store relationship type.
|
static java.lang.String |
CHANNEL_RESOURCE
Channel store relationship type.
|
static java.lang.String |
COPYRIGHT
IBM copyright notice field.
|
static java.lang.String |
EQUAL
Equal.
|
static java.lang.String |
MAX_SEARCH
The maximum number of matches from the product search bean.
|
static java.lang.String |
MODE
The search mode parameter name.
|
static java.lang.String |
OPEN_STORES
Only stores with open state.
|
static java.lang.String |
OPENCLOSE_STORES
Stores with open and closed state.
|
static java.lang.String |
SEARCH_BY_PRODUCT
Locate stores by products.
|
static java.lang.String |
SEARCH_BY_STCATEGORY
Locate stores by store category.
|
static java.lang.String |
SEARCH_STORES
The stores to search parameter name.
|
static java.lang.String |
STORECATEGORYID
The store category id parameter name.
|
Constructor and Description |
---|
StoreLocatorDataBean()
This method creates a new
StoreLocatorDataBean by calling the super constructor. |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getCategoryTerm()
This method gets the category term to find.
|
java.lang.String |
getCategoryTermScope()
This method gets the category term scope to be used.
|
java.lang.String |
getCategoryType()
This method gets the category type criteria for this search.
|
boolean |
getIsBundle()
This method gets the value of the
isBundle parameter. |
boolean |
getIsItem()
This method gets the value of the
isItem parameter. |
boolean |
getIsPackage()
This method gets the value of the
isPackage parameter. |
boolean |
getIsProduct()
This method gets the value of the
isProduct parameter. |
java.lang.String |
getMode()
This method gets the search mode which describes the type of search desired.
|
int |
getQuerySize()
This method gets the size of the entire query.
|
java.util.Vector |
getResultSet()
This method gets the entire result set of the query.
|
java.util.Vector |
getResultSubset()
This method gets the subset that the page needs for display.
|
java.lang.String |
getSearchStores()
This method gets the search stores parameter value.
|
java.lang.String |
getSearchTerm()
This method gets the search term to find.
|
java.lang.String |
getSearchTermScope()
This method gets the search term scope to be used.
|
java.lang.String |
getSearchType()
This method gets the search type criteria for this search.
|
java.lang.String |
getSku()
This method gets the sku value to find.
|
java.lang.String |
getStoreCategoryId()
This method gets the store category id to search for.
|
void |
populate()
Loads data into the data bean when the
DataBeanManager.activate() executes. |
void |
setBeginIndex(int inBeginIndex)
This method sets the index of the first item to be returned.
|
void |
setCategoryTerm(java.lang.String categoryTerm)
This method sets the category term to find.
|
void |
setCategoryTermScope(java.lang.String categoryTermScope)
This method sets the category term scope to be used.
|
void |
setCategoryType(java.lang.String categoryType)
This method sets the category type criteria for this search.
|
void |
setIsBundle(boolean isBundle)
This method sets the value of the
isBundle parameter. |
void |
setIsItem(boolean isItem)
This method sets the value of the
isItem parameter. |
void |
setIsPackage(boolean isPackage)
This method sets the value of the
isPackage parameter. |
void |
setIsProduct(boolean isProduct)
This method sets the value of the
isProduct parameter. |
void |
setMode(java.lang.String inMode)
This method sets the search mode which describes the type of search desired.
|
void |
setPageSize(int inPageSize)
This method sets the maximum number of rows that the page can display.
|
void |
setSearchStores(java.lang.String inSearchStores)
This method sets the search stores parameter value
|
void |
setSearchTerm(java.lang.String searchTerm)
This method sets the search term to find.
|
void |
setSearchTermScope(java.lang.String searchTermScope)
This method sets the search term scope to be used.
|
void |
setSearchType(java.lang.String searchType)
This method sets the search type criteria for this search.
|
void |
setSku(java.lang.String sku)
This method sets the sku to find.
|
void |
setStoreCategoryId(java.lang.String inStoreCategoryId)
This method sets the store category to find.
|
fulfills, getCommandContext, getHttpRequest, getHttpResponse, getResources, getViewCommandContext, setCommandContext, setHttpRequest, setHttpResponse, setViewCommandContext
getRequestProperties, setRequestProperties
public static final java.lang.String ALL_CATEGORIES
public static final java.lang.String ALL_STORES
public static final java.lang.String CATALOG_RESOURCE
public static final java.lang.String CHANNEL_RESOURCE
public static final java.lang.String COPYRIGHT
public static final java.lang.String EQUAL
public static final java.lang.String MAX_SEARCH
public static final java.lang.String MODE
public static final java.lang.String OPEN_STORES
public static final java.lang.String OPENCLOSE_STORES
public static final java.lang.String SEARCH_BY_PRODUCT
public static final java.lang.String SEARCH_BY_STCATEGORY
public static final java.lang.String SEARCH_STORES
public static final java.lang.String STORECATEGORYID
public StoreLocatorDataBean()
StoreLocatorDataBean
by calling the super constructor.public java.lang.String getCategoryTerm()
public java.lang.String getCategoryTermScope()
public java.lang.String getCategoryType()
public boolean getIsBundle()
isBundle
parameter.public boolean getIsItem()
isItem
parameter.public boolean getIsPackage()
isPackage
parameter.public boolean getIsProduct()
isProduct
parameter.public java.lang.String getMode()
public int getQuerySize()
public java.util.Vector getResultSet()
catentryId
(String) storeId
(String)].
For store category search mode, the result is a vector of vectors
of [StoreAccessBean storeCategoryId
(String)].public java.util.Vector getResultSubset()
beginIndex
and pageSize
parameters.public java.lang.String getSearchStores()
public java.lang.String getSearchTerm()
public java.lang.String getSearchTermScope()
public java.lang.String getSearchType()
public java.lang.String getSku()
public java.lang.String getStoreCategoryId()
public void populate() throws java.lang.Exception
DataBeanManager.activate()
executes.
The main logic of the data bean is in this method. The resulting objects will be determined by executing the search queries
depending on the parameters that are set in the bean.populate
in interface com.ibm.commerce.beans.SmartDataBean
populate
in class com.ibm.commerce.beans.SmartDataBeanImpl
java.lang.Exception
public void setBeginIndex(int inBeginIndex)
inBeginIndex
- The index of the first item that needs to be returnedpublic void setCategoryTerm(java.lang.String categoryTerm)
categoryTerm
- The category term to usepublic void setCategoryTermScope(java.lang.String categoryTermScope)
categoryTermScope
- The category term scope to usepublic void setCategoryType(java.lang.String categoryType)
searchType
- The category type criteriapublic void setIsBundle(boolean isBundle)
isBundle
parameter.isBundle
- Set the parameter to true to search for bundles, false otherwise.public void setIsItem(boolean isItem)
isItem
parameter.isItem
- Set the parameter to true to search for items, false otherwise.public void setIsPackage(boolean isPackage)
isPackage
parameter.isPackage
- Set the parameter to true to search for packages, false otherwise.public void setIsProduct(boolean isProduct)
isProduct
parameter.isProduct
- Set the parameter to true to search for products, false otherwise.public void setMode(java.lang.String inMode)
inMode
- The search mode which describes the type of search desired.public void setPageSize(int inPageSize)
newMaxListSize
- The maximum number of rows that the page can displaypublic void setSearchStores(java.lang.String inSearchStores)
inSearchStores
- The search stores parameter valuepublic void setSearchTerm(java.lang.String searchTerm)
searchTerm
- The search term to usepublic void setSearchTermScope(java.lang.String searchTermScope)
searchTermScope
- The search term scope to usepublic void setSearchType(java.lang.String searchType)
searchType
- The search type criteriapublic void setSku(java.lang.String sku)
sku
- The sku valuepublic void setStoreCategoryId(java.lang.String inStoreCategoryId)
inSearchStores
- The store category to find