com.ibm.commerce.tools.campaigns
Class ProductTreeDataBean

java.lang.Object
  |
  +--com.ibm.commerce.tools.campaigns.ProductTreeDataBean
All Implemented Interfaces:
DataBean, DynamicTreeUserDataBean, InputDataBean, java.io.Serializable, SmartDataBean

public class ProductTreeDataBean
extends java.lang.Object
implements DynamicTreeUserDataBean

The ProductTreeDataBean class extends the com.ibm.commerce.tools.common.ui.DynamicTreeUserDataBean class to create the catalog browser used in campaign creation.

See Also:
Serialized Form

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
          Define catalog entry type constants
static java.lang.String CATENTRY_TYPE_DYNAMIC_KIT
          Define catalog entry type constants
static java.lang.String CATENTRY_TYPE_ITEM
          Define catalog entry type constants
static java.lang.String CATENTRY_TYPE_PACKAGE
          Define catalog entry type constants
static java.lang.String CATENTRY_TYPE_PRODUCT
          Define catalog entry type constants
protected  CommandContext commandContext
          The command context used in this bean.
protected  java.util.Vector iconInfo
          The vector of all the icon information in the tree.
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.
protected  java.lang.String selectionType
          The selection type of this product tree.
 
Fields inherited from interface com.ibm.commerce.beans.SmartDataBean
COPYRIGHT
 
Fields inherited from interface com.ibm.commerce.beans.DataBean
emptyString
 
Constructor Summary
ProductTreeDataBean()
          Constructs a ProductTreeDataBean object.
 
Method Summary
 java.lang.String getCatalogId()
          getCatalogId method is used to get the catalog ID defined in the root of this product tree.
 java.lang.String getCategoryId()
          getCategoryId method is used to get the category ID of the selected tree node.
 CommandContext getCommandContext()
          getCommandContext method is used to get the commandContext associated with the data bean.
 java.util.Vector getIconInfo()
          getIconInfo method is used to get the icon information.
 java.lang.String getLocationType()
          getLocationType method is used to get the location type of this product tree.
 java.util.Vector getMenuInfo()
          getMenuInfo method is used to get the menu information.
 java.util.Vector getNodeInfo()
          getNodeInfo method is used to get the node information.
 TypedProperty getRequestProperties()
          getRequestProperties method is used to get the requestProperties associated with the data bean.
 java.lang.String getSelectionType()
          getSelectionType method is used to get the selection type of this product tree.
 void populate()
          populate the databean, you should've got everything you want from requestProperties and commandContext before this method is executed Populate all nodes info and append to the nodeInfo vector, which will be later retrived by a caller databean through getNodeInfo() method
 void setCommandContext(CommandContext cc)
          setCommandContext method is used to set the commandContext associated with the data bean.
 void setRequestProperties(TypedProperty param)
          setRequestProperties method is used to set the requestProperties associated with the data bean.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

catalogId

protected java.lang.String catalogId
The catalog ID defined in the root of this product tree.

categoryId

protected java.lang.String categoryId
The category ID holder to be used when constructing the tree.

CATENTRY_TYPE_BUNDLE

public static final java.lang.String CATENTRY_TYPE_BUNDLE
Define catalog entry type constants

CATENTRY_TYPE_DYNAMIC_KIT

public static final java.lang.String CATENTRY_TYPE_DYNAMIC_KIT
Define catalog entry type constants

CATENTRY_TYPE_ITEM

public static final java.lang.String CATENTRY_TYPE_ITEM
Define catalog entry type constants

CATENTRY_TYPE_PACKAGE

public static final java.lang.String CATENTRY_TYPE_PACKAGE
Define catalog entry type constants

CATENTRY_TYPE_PRODUCT

public static final java.lang.String CATENTRY_TYPE_PRODUCT
Define catalog entry type constants

commandContext

protected CommandContext commandContext
The command context used in this bean.

iconInfo

protected java.util.Vector iconInfo
The vector of all the icon information in the tree.

locationType

protected java.lang.String locationType
The location type of this product tree.

menuInfo

protected java.util.Vector menuInfo
The vector of all the menu information in the tree.

nodeInfo

protected java.util.Vector nodeInfo
The vector of all the node information in the tree.

selectionType

protected java.lang.String selectionType
The selection type of this product tree.
Constructor Detail

ProductTreeDataBean

public ProductTreeDataBean()
Constructs a ProductTreeDataBean object.
Method Detail

getCatalogId

public java.lang.String getCatalogId()
                              throws ECSystemException
getCatalogId method is used to get the catalog ID defined in the root of this product tree.
Returns:
The catalog ID defined in the root of this product tree.

getCategoryId

public java.lang.String getCategoryId()
                               throws ECSystemException
getCategoryId method is used to get the category ID of the selected tree node.
Returns:
The category ID of the selected tree node.

getCommandContext

public CommandContext getCommandContext()
getCommandContext method is used to get the commandContext associated with the data bean.
Specified by:
getCommandContext in interface SmartDataBean
Returns:
The command context passed to the JSP page that invokes this data bean.

getIconInfo

public java.util.Vector getIconInfo()
                             throws ECSystemException
getIconInfo method is used to get the icon information.
Specified by:
getIconInfo in interface DynamicTreeUserDataBean
Returns:
A vector object that contains the icon information.

getLocationType

public java.lang.String getLocationType()
                                 throws ECSystemException
getLocationType method is used to get the location type of this product tree.
Returns:
The location type of this product tree.

getMenuInfo

public java.util.Vector getMenuInfo()
                             throws ECSystemException
getMenuInfo method is used to get the menu information.
Specified by:
getMenuInfo in interface DynamicTreeUserDataBean
Returns:
A vector object that contains the menu information.

getNodeInfo

public java.util.Vector getNodeInfo()
                             throws ECSystemException
getNodeInfo method is used to get the node information.
Specified by:
getNodeInfo in interface DynamicTreeUserDataBean
Returns:
A vector object that contains the node information.

getRequestProperties

public TypedProperty getRequestProperties()
getRequestProperties method is used to get the requestProperties associated with the data bean.
Specified by:
getRequestProperties in interface InputDataBean
Returns:
The set of properties passed to the JSP page that invokes this data bean.

getSelectionType

public java.lang.String getSelectionType()
                                  throws ECSystemException
getSelectionType method is used to get the selection type of this product tree.
Returns:
The selection type of this product tree.

populate

public void populate()
              throws java.lang.Exception
populate the databean, you should've got everything you want from requestProperties and commandContext before this method is executed Populate all nodes info and append to the nodeInfo vector, which will be later retrived by a caller databean through getNodeInfo() method
Specified by:
populate in interface SmartDataBean

setCommandContext

public void setCommandContext(CommandContext cc)
setCommandContext method is used to set the commandContext associated with the data bean. This is called by the DataBeanManager during the activate method.
Specified by:
setCommandContext in interface SmartDataBean
Parameters:
cc - The command context passed to the JSP page that invokes this data bean.

setRequestProperties

public void setRequestProperties(TypedProperty param)
                          throws java.lang.Exception
setRequestProperties method is used to set the requestProperties associated with the data bean. This is called by the DataBeanManager during the activate method.
Specified by:
setRequestProperties in interface InputDataBean
Parameters:
requestProperties - The set of properties passed to the JSP page that invokes this data bean.