com.ibm.commerce.tools.contract.beans
Class CatalogFilterTreeDataBean

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

public class CatalogFilterTreeDataBean
extends java.lang.Object
implements DynamicTreeUserDataBean

The CatalogFilterTreeDataBean class implements the com.ibm.commerce.tools.common.ui.DynamicTreeUserDataBean interface to create the catalog browser used in Catalog Filter.

See Also:
Serialized Form

Field Summary
static java.lang.String CATENTRY_TYPE_BUNDLE
          Catentry Type Bundle
static java.lang.String CATENTRY_TYPE_DYNAMIC_KIT
          Catentry Type Dyanamic Kit
static java.lang.String CATENTRY_TYPE_ITEM
          Catentry Type Item
static java.lang.String CATENTRY_TYPE_PACKAGE
          Catentry Type Package
static java.lang.String CATENTRY_TYPE_PRODUCT
          Catentry Type Product
static java.lang.String NODE_TYPE_BUNDLE
          Tree Node Types Bundle
static java.lang.String NODE_TYPE_CATALOG
          Tree Node Types Catalog
static java.lang.String NODE_TYPE_CATEGORY
          Tree Node Types Category
static java.lang.String NODE_TYPE_CATENTRY
          Tree Node Types Catentry
static java.lang.String NODE_TYPE_DYNAMIC_KIT
          Tree Node Types Dynamic Kit
static java.lang.String NODE_TYPE_ITEM
          Tree Node Types Item
static java.lang.String NODE_TYPE_PRODUCT
          Tree Node Types Product
static java.lang.String NODE_TYPE_RESELLER_CATENTRY
          Tree Node Types Reseller Catentry
static java.lang.String NODE_TYPE_RESELLER_CATGROUP
          Tree Node Types Reseller Catgroup
static java.lang.String NODE_TYPE_RESELLER_OVERRIDE
          Tree Node Types Reseller Override
static java.lang.String NODE_TYPE_SEPARATOR
          Tree Node Types Separator
 
Fields inherited from interface com.ibm.commerce.tools.common.ui. DynamicTreeUserDataBean
COPYRIGHT
 
Fields inherited from interface com.ibm.commerce.beans. DataBean
emptyString
 
Constructor Summary
CatalogFilterTreeDataBean()
          Constructs a CatalogFilterTreeDataBean object.
 
Method Summary
  CommandContext getCommandContext()
          Gets the commandContext 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.
 java.lang.String getLanguageId()
          Gets the language identifier for the language in which to fetch.
 java.util.Vector getMenuInfo()
          Gets the menu information.
 java.util.Vector getNodeInfo()
          Gets the node information.
  TypedProperty getRequestProperties()
          Gets the requestProperties associated with the data bean.
 java.lang.String getStoreId()
          Gets the store identifier.
 java.lang.String getStoreIds()
          Gets the store identifiers for all the related stores in the store path.
 void populate()
          Populates 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)
          Sets the commandContext associated with the data bean.
 void setLanguageId(java.lang.String newLanguageId)
          Sets the language identifier in which to search.
 void setRequestProperties( TypedProperty param)
          Sets the requestProperties associated with the data bean.
 void setTraceMode(boolean newTraceMode)
          Sets the debug mode.
 void trace(java.lang.String traceString)
          Outputs a line of trace if trace mode is true.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CATENTRY_TYPE_PRODUCT

public static final java.lang.String CATENTRY_TYPE_PRODUCT
Catentry Type Product

CATENTRY_TYPE_ITEM

public static final java.lang.String CATENTRY_TYPE_ITEM
Catentry Type Item

CATENTRY_TYPE_PACKAGE

public static final java.lang.String CATENTRY_TYPE_PACKAGE
Catentry Type Package

CATENTRY_TYPE_BUNDLE

public static final java.lang.String CATENTRY_TYPE_BUNDLE
Catentry Type Bundle

CATENTRY_TYPE_DYNAMIC_KIT

public static final java.lang.String CATENTRY_TYPE_DYNAMIC_KIT
Catentry Type Dyanamic Kit

NODE_TYPE_CATALOG

public static final java.lang.String NODE_TYPE_CATALOG
Tree Node Types Catalog
See Also:
Constant Field Values

NODE_TYPE_CATEGORY

public static final java.lang.String NODE_TYPE_CATEGORY
Tree Node Types Category
See Also:
Constant Field Values

NODE_TYPE_CATENTRY

public static final java.lang.String NODE_TYPE_CATENTRY
Tree Node Types Catentry
See Also:
Constant Field Values

NODE_TYPE_SEPARATOR

public static final java.lang.String NODE_TYPE_SEPARATOR
Tree Node Types Separator
See Also:
Constant Field Values

NODE_TYPE_BUNDLE

public static final java.lang.String NODE_TYPE_BUNDLE
Tree Node Types Bundle
See Also:
Constant Field Values

NODE_TYPE_DYNAMIC_KIT

public static final java.lang.String NODE_TYPE_DYNAMIC_KIT
Tree Node Types Dynamic Kit
See Also:
Constant Field Values

NODE_TYPE_ITEM

public static final java.lang.String NODE_TYPE_ITEM
Tree Node Types Item
See Also:
Constant Field Values

NODE_TYPE_PRODUCT

public static final java.lang.String NODE_TYPE_PRODUCT
Tree Node Types Product
See Also:
Constant Field Values

NODE_TYPE_RESELLER_OVERRIDE

public static final java.lang.String NODE_TYPE_RESELLER_OVERRIDE
Tree Node Types Reseller Override
See Also:
Constant Field Values

NODE_TYPE_RESELLER_CATGROUP

public static final java.lang.String NODE_TYPE_RESELLER_CATGROUP
Tree Node Types Reseller Catgroup
See Also:
Constant Field Values

NODE_TYPE_RESELLER_CATENTRY

public static final java.lang.String NODE_TYPE_RESELLER_CATENTRY
Tree Node Types Reseller Catentry
See Also:
Constant Field Values
Constructor Detail

CatalogFilterTreeDataBean

public CatalogFilterTreeDataBean()
Constructs a CatalogFilterTreeDataBean object.
Method Detail

getCommandContext

public CommandContext getCommandContext()
Gets 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()
Gets the icon information.
Specified by:
getIconInfo in interface DynamicTreeUserDataBean
Returns:
A vector object that contains the icon information.

getDefaultLanguageId

public java.lang.String getDefaultLanguageId()
                                      throws java.lang.Exception
Gets the language identifier for the language in which to search.
Returns:
java.lang.String - language identifier
Throws:
java.lang.Exception - - Thrown whenever an exception is encountered.

getLanguageId

public java.lang.String getLanguageId()
                               throws java.lang.Exception
Gets the language identifier for the language in which to fetch.
Returns:
java.lang.String - language identifier
Throws:
java.lang.Exception - - Thrown whenever an exception is encountered.

getMenuInfo

public java.util.Vector getMenuInfo()
Gets the menu information.
Specified by:
getMenuInfo in interface DynamicTreeUserDataBean
Returns:
A vector object that contains the menu information.

getNodeInfo

public java.util.Vector getNodeInfo()
Gets the node information.
Specified by:
getNodeInfo in interface DynamicTreeUserDataBean
Returns:
A vector object that contains the node information.

getRequestProperties

public TypedProperty getRequestProperties()
Gets 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.

getStoreId

public java.lang.String getStoreId()
                            throws java.lang.Exception
Gets the store identifier.
Returns:
java.lang.String - store identifier
Throws:
java.lang.Exception - - Thrown whenever an exception is encountered while retrieving store Id

getStoreIds

public java.lang.String getStoreIds()
                             throws java.lang.Exception
Gets the store identifiers for all the related stores in the store path.
Returns:
java.lang.String - store identifiers
Throws:
java.lang.Exception - - Thrown whenever an exception is encountered while retrieving related stores using the store access bean.

populate

public void populate()
              throws java.lang.Exception
Populates 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
Throws:
java.lang.Exception - - Thrown whenever an exception is encountered.

setCommandContext

public void setCommandContext(CommandContext cc)
Sets 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.

setLanguageId

public void setLanguageId(java.lang.String newLanguageId)
Sets the language identifier in which to search.

setRequestProperties

public void setRequestProperties(TypedProperty param)
Sets the requestProperties associated with the data bean. This is called by the DataBeanManager during the activate method.
Specified by:
setRequestProperties in interface InputDataBean

setTraceMode

public void setTraceMode(boolean newTraceMode)
Sets the debug mode.
Parameters:
newTraceMode - boolean

trace

public void trace(java.lang.String traceString)
Outputs a line of trace if trace mode is true.
Parameters:
traceString - String