java.lang.Object | +--com.ibm.commerce.tools.campaigns.ProductTreeDataBean
The ProductTreeDataBean class extends the
com.ibm.commerce.tools.common.ui.DynamicTreeUserDataBean
class to
create the catalog browser used in campaign creation.
Field Summary | |
---|---|
protected
java.lang.String |
catalogId The catalog ID defined in the root of this product tree. |
protected
java.lang.String |
categoryId The category ID holder to be used when constructing the tree. |
static java.lang.String |
CATENTRY_TYPE_BUNDLE Catalog entry type constants |
static java.lang.String |
CATENTRY_TYPE_DYNAMIC_KIT Catalog entry type constants |
static java.lang.String |
CATENTRY_TYPE_ITEM Catalog entry type constants |
static java.lang.String |
CATENTRY_TYPE_PACKAGE Catalog entry type constants |
static java.lang.String |
CATENTRY_TYPE_PRODUCT Catalog entry type constants |
protected
java.lang.String |
catentryId The catalog entry ID holder to be used when constructing the tree. |
protected
CommandContext |
commandContext The command context used in this bean. |
static java.lang.String |
COPYRIGHT IBM copyright notice field. |
protected
java.lang.String |
defaultLanguageId The ID of the runtime default language. |
protected
java.util.Vector |
iconInfo The vector of all the icon information in the tree. |
protected
java.lang.String |
languageId The ID of the language that the node entry is in. |
protected
java.lang.String |
locationType The location type of this product tree. |
protected
java.util.Vector |
menuInfo The vector of all the menu information in the tree. |
protected
java.util.Vector |
nodeInfo The vector of all the node information in the tree. |
static java.lang.String |
QUERY_TYPE_FIND_CATALOG_BY_STORE Query type constants |
static java.lang.String |
QUERY_TYPE_FIND_CATENTRY_BY_CATGROUP Query type constants |
static java.lang.String |
QUERY_TYPE_FIND_CATGROUP_BY_CATALOG Query type constants |
static java.lang.String |
QUERY_TYPE_FIND_CHILD_CATENTRY_BY_PARENT_CATENTRY Query type constants |
static java.lang.String |
QUERY_TYPE_FIND_CHILD_CATGROUP_BY_PARENT_CATGROUP Query type constants |
protected
java.lang.String |
queryType The query type defines which query is to be executed to get the appropriate data to display in the current tree level. |
protected
TypedProperty |
requestProperties The request properties used in this bean. |
protected
java.lang.String |
selectionType The selection type of this product tree. |
protected
java.lang.String |
storeId The ID of the current store. |
protected
java.lang.String |
storeIds The IDs of the all the related stores in the store path. |
protected
java.lang.String |
storeRelType The store relationship type in the store path. |
Fields inherited from interface com.ibm.commerce.beans. DataBean |
emptyString |
Constructor Summary | |
---|---|
ProductTreeDataBean() Constructs a ProductTreeDataBean object. |
Method Summary | |
---|---|
DynamicTreeNode |
buildCatalogNode(java.util.Vector catalogRow) Builds a catalog node for the dynamic tree. |
DynamicTreeNode |
buildCategoryNode(java.util.Vector categoryRow) Builds a category node for the dynamic tree. |
DynamicTreeNode |
buildCatentryNode(java.util.Vector catentryRow) Builds a catalog entry node for the dynamic tree. |
java.lang.String |
buildQuery() Constructs the database query that is used to fetch tree node data. |
java.lang.String |
getCatalogId() Gets the catalog ID defined in the root of this product tree. |
java.lang.String |
getCategoryId() Gets the category ID of the selected tree node. |
java.lang.String |
getCatentryId() Gets the catalog entry ID of the selected tree node. |
CommandContext |
getCommandContext() Gets the command context associated with the data bean. |
java.lang.String |
getDefaultLanguageId() Gets the language identifier for the language in which to search. |
java.util.Vector |
getIconInfo() Gets the icon information of the dynamic tree node, represented by a Vector object. |
java.lang.String |
getLanguageId() Gets the language identifier for the language in which to fetch. |
java.lang.String |
getLocationType() Gets the location type of this product tree, where different locations represent different search type. |
java.util.Vector |
getMenuInfo() Gets the menu information of the dynamic tree node, represented by a Vector object. |
java.util.Vector |
getNodeInfo() Gets the node information of the dynamic tree node, represented by a Vector object. |
java.lang.String |
getQueryType() Gets the query type of the current tree level, where different types map to a query that finds different types of result (catalog, category or catalog entry). |
TypedProperty |
getRequestProperties() Gets the request properties associated with the data bean. |
java.lang.String |
getSelectionType() Gets the selection type of this product tree, which identifies whether this tree is used for category selection, catalog entry selection, or both. |
java.lang.String |
getStoreId() Gets the ID of the store that is currently logged on to. |
java.lang.String |
getStoreIds() Gets the store identifiers for all the related stores in the store path. |
java.lang.String |
getStoreRelType() Gets the store relationship type in the store path. |
void |
populate() Populates all nodes info and append to the nodeInfo vector, which will be later retrieved by a caller data bean through getNodeInfo() method. |
void |
setCatalogId(java.lang.String newCatalogId) Sets the catalog ID defined in the root of this product tree. |
void |
setCategoryId(java.lang.String newCategoryId) Sets the category ID of the selected tree node. |
void |
setCatentryId(java.lang.String newCatentryId) Sets the catalog entry ID of the selected tree node. |
void |
setCommandContext(
CommandContext cc) Sets the command context associated with the data bean. |
void |
setLanguageId(java.lang.String newLanguageId) Sets the language identifier for the language in which to fetch. |
void |
setLocationType(java.lang.String newLocationType) Sets the location type of this product tree, where different locations represent different search type. |
void |
setQueryType(java.lang.String newQueryType) Sets the query type of the current tree level, where different types map to a query that finds different types of result (catalog, category or catalog entry). |
void |
setRequestProperties(
TypedProperty param) Sets the request properties associated with the data bean. |
void |
setSelectionType(java.lang.String newSelectionType) Sets the selection type of this product tree, which identifies whether this tree is used for category selection, catalog entry selection, or both. |
void |
setStoreId(java.lang.String newStoreId) Sets the ID of the store that is currently logged on to. |
void |
setStoreIds(java.lang.String newStoreIds) Sets the store identifiers for all the related stores in the store path. |
void |
setStoreRelType(java.lang.String newStoreRelType) Sets the store relationship type in the store path. |
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 COPYRIGHT
protected java.lang.String catalogId
protected java.lang.String categoryId
protected java.lang.String catentryId
protected CommandContext commandContext
protected java.lang.String defaultLanguageId
protected java.util.Vector iconInfo
protected java.lang.String languageId
protected java.lang.String locationType
protected java.util.Vector menuInfo
protected java.util.Vector nodeInfo
protected java.lang.String queryType
protected TypedProperty requestProperties
protected java.lang.String selectionType
protected java.lang.String storeId
protected java.lang.String storeIds
protected java.lang.String storeRelType
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
public static final java.lang.String QUERY_TYPE_FIND_CATALOG_BY_STORE
public static final java.lang.String QUERY_TYPE_FIND_CATGROUP_BY_CATALOG
public static final java.lang.String QUERY_TYPE_FIND_CHILD_CATGROUP_BY_PARENT_CATGROUP
public static final java.lang.String QUERY_TYPE_FIND_CATENTRY_BY_CATGROUP
public static final java.lang.String QUERY_TYPE_FIND_CHILD_CATENTRY_BY_PARENT_CATENTRY
Constructor Detail |
---|
public ProductTreeDataBean()
Method Detail |
---|
public DynamicTreeNode buildCatalogNode(java.util.Vector catalogRow)
catalogRow
- catalog row from the
ServerJDBCHelper
beanDynamicTreeNode
object that represents a catalog
node.public DynamicTreeNode buildCategoryNode(java.util.Vector categoryRow)
categoryRow
- category row from the
ServerJDBCHelper
beanDynamicTreeNode
object that represents a category
node.public DynamicTreeNode buildCatentryNode(java.util.Vector catentryRow)
catentryRow
- catalog entry row from the
ServerJDBCHelper
beanDynamicTreeNode
object that represents a catalog entry
node.public java.lang.String buildQuery() throws java.lang.Exception
java.lang.Exception
- Thrown whenever an exception is
encountered.public java.lang.String getCatalogId() throws ECSystemException
ECSystemException
- Thrown whenever an EC system exception is
encountered.public java.lang.String getCategoryId() throws ECSystemException
ECSystemException
- Thrown whenever an EC system exception is
encountered.public java.lang.String getCatentryId() throws ECSystemException
ECSystemException
- Thrown whenever an EC system exception is
encountered.public CommandContext getCommandContext()
getCommandContext
in interface
SmartDataBean
public java.lang.String getDefaultLanguageId() throws java.lang.Exception
java.lang.Exception
- Thrown whenever an exception is
encountered.public java.util.Vector getIconInfo() throws ECSystemException
Vector
object.
getIconInfo
in interface
DynamicTreeUserDataBean
ECSystemException
- Thrown whenever an EC system exception is
encountered.public java.lang.String getLanguageId() throws ECSystemException
ECSystemException
- Thrown whenever an EC system exception is
encountered.public java.lang.String getLocationType() throws ECSystemException
ECSystemException
- Thrown whenever an EC system exception is
encountered.public java.util.Vector getMenuInfo() throws ECSystemException
Vector
object.
getMenuInfo
in interface
DynamicTreeUserDataBean
ECSystemException
- Thrown whenever an EC system exception is
encountered.public java.util.Vector getNodeInfo() throws ECSystemException
Vector
object.
getNodeInfo
in interface
DynamicTreeUserDataBean
ECSystemException
- Thrown whenever an EC system exception is
encountered.public java.lang.String getQueryType() throws ECSystemException
ECSystemException
- Thrown whenever an EC system exception is
encountered.public TypedProperty getRequestProperties()
getRequestProperties
in interface
InputDataBean
public java.lang.String getSelectionType() throws ECSystemException
ECSystemException
- Thrown whenever an EC system exception is
encountered.public java.lang.String getStoreId() throws ECSystemException
ECSystemException
- Thrown whenever an EC system exception is
encountered.public java.lang.String getStoreIds() throws java.lang.Exception
java.lang.Exception
- Thrown whenever an exception is
encountered while retrieving related stores using the store access
bean.public java.lang.String getStoreRelType() throws ECSystemException
ECSystemException
- Thrown whenever an EC system exception is
encountered.public void populate() throws java.lang.Exception
populate
in interface
SmartDataBean
java.lang.Exception
- Thrown whenever an exception is
encountered.public void setCatalogId(java.lang.String newCatalogId)
newCatalogId
- The catalog ID defined in the root of this
product tree.public void setCategoryId(java.lang.String newCategoryId)
newCategoryId
- the category ID of the selected tree
nodepublic void setCatentryId(java.lang.String newCatentryId)
newCatentryId
- the catalog entry ID of the selected tree
nodepublic void setCommandContext(CommandContext cc)
DataBeanManager
during the activate method.
setCommandContext
in interface
SmartDataBean
cc
- The command context passed to the JSP page that invokes
this data bean.public void setLanguageId(java.lang.String newLanguageId)
newLanguageId
- the language identifierpublic void setLocationType(java.lang.String newLocationType)
newLocationType
- the location type of this product
treepublic void setQueryType(java.lang.String newQueryType)
newQueryType
- the query type of the current tree
levelpublic void setRequestProperties(TypedProperty param)
DataBeanManager
during the activate method.
setRequestProperties
in interface
InputDataBean
param
- The set of properties passed to the JSP page that
invokes this data bean.public void setSelectionType(java.lang.String newSelectionType)
newSelectionType
- the selection type of this product
treepublic void setStoreId(java.lang.String newStoreId)
newStoreId
- the current store IDpublic void setStoreIds(java.lang.String newStoreIds)
newStoreIds
- the store identifierspublic void setStoreRelType(java.lang.String newStoreRelType)
newStoreRelType
- store relationship type