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

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

public class ProductTreeDataBean
extends java.lang.Object
implements DynamicTreeUserDataBean

Display the results of a product search in a tree view

See Also:
Serialized Form

Field Summary
protected  java.lang.String catalogId
           
protected  java.lang.String categoryId
           
static java.lang.String CATENTRY_TYPE_BUNDLE
          Catentry type constannts
static java.lang.String CATENTRY_TYPE_ITEM
          Catentry type constannts
static java.lang.String CATENTRY_TYPE_PACKAGE
          Catentry type constannts
static java.lang.String CATENTRY_TYPE_PRODUCT
          Catentry type constannts
protected  CommandContext commandContext
           
protected  java.util.Vector iconInfo
           
protected  java.util.Vector menuInfo
           
protected  java.util.Vector nodeInfo
           
protected  java.lang.String selectionType
           
 
Fields inherited from interface com.ibm.commerce.tools.common.ui. DynamicTreeUserDataBean
COPYRIGHT
 
Fields inherited from interface com.ibm.commerce.beans. DataBean
emptyString
 
Constructor Summary
ProductTreeDataBean()
          Construct a ProductTreeDataBean
 
Method Summary
 java.lang.String getCatalogId()
          Get the catalog identifier for the tree
 java.lang.String getCategoryId()
          Get the category identifier for the tree
  CommandContext getCommandContext()
          Get the command context
 java.lang.String getDefaultLanguageId()
          Get the language identifier for the language in which to search
 java.util.Vector getIconInfo()
          Get the information for the icons in the tree
 java.lang.String getLanguageId()
          Get the language identifier for the language in which to fetch.
 java.util.Vector getMenuInfo()
          Get the information for the menu
 java.util.Vector getNodeInfo()
          Get the information for the nodes in the tree
  TypedProperty getRequestProperties()
          Get the request properties
 java.lang.String getSelectionType()
          Get the selection type
 java.lang.String getStoreId()
          Get the store identifier
 java.lang.String getStoreIds()
          Get the store identifiers for all the related stores in the store path
 void populate()
          Populates the databean.
 void setCommandContext( CommandContext cc)
          Set the command context
 void setRequestProperties( TypedProperty param)
          Sets 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

commandContext

protected CommandContext commandContext

nodeInfo

protected java.util.Vector nodeInfo

iconInfo

protected java.util.Vector iconInfo

protected java.util.Vector menuInfo

selectionType

protected java.lang.String selectionType

catalogId

protected java.lang.String catalogId

categoryId

protected java.lang.String categoryId

CATENTRY_TYPE_PRODUCT

public static final java.lang.String CATENTRY_TYPE_PRODUCT
Catentry type constannts
See Also:
Constant Field Values

CATENTRY_TYPE_ITEM

public static final java.lang.String CATENTRY_TYPE_ITEM
Catentry type constannts
See Also:
Constant Field Values

CATENTRY_TYPE_PACKAGE

public static final java.lang.String CATENTRY_TYPE_PACKAGE
Catentry type constannts
See Also:
Constant Field Values

CATENTRY_TYPE_BUNDLE

public static final java.lang.String CATENTRY_TYPE_BUNDLE
Catentry type constannts
See Also:
Constant Field Values
Constructor Detail

ProductTreeDataBean

public ProductTreeDataBean()
Construct a ProductTreeDataBean
Method Detail

getCatalogId

public java.lang.String getCatalogId()
                              throws ECSystemException
Get the catalog identifier for the tree
Returns:
String
Throws:
ECSystemException

getCategoryId

public java.lang.String getCategoryId()
                               throws ECSystemException
Get the category identifier for the tree
Returns:
String
Throws:
ECSystemException

getCommandContext

public CommandContext getCommandContext()
Get the command context
Specified by:
getCommandContext in interface SmartDataBean
Returns:
The command context.

getIconInfo

public java.util.Vector getIconInfo()
                             throws ECSystemException
Get the information for the icons in the tree
Specified by:
getIconInfo in interface DynamicTreeUserDataBean
Returns:
Vector
Throws:
ECSystemException

getMenuInfo

public java.util.Vector getMenuInfo()
                             throws ECSystemException
Get the information for the menu
Specified by:
getMenuInfo in interface DynamicTreeUserDataBean
Returns:
Vector
Throws:
ECSystemException

getNodeInfo

public java.util.Vector getNodeInfo()
                             throws ECSystemException
Get the information for the nodes in the tree
Specified by:
getNodeInfo in interface DynamicTreeUserDataBean
Returns:
Vector
Throws:
ECSystemException

getRequestProperties

public TypedProperty getRequestProperties()
Get the request properties
Specified by:
getRequestProperties in interface InputDataBean
Returns:
The request properties.

getSelectionType

public java.lang.String getSelectionType()
                                  throws ECSystemException
Get the selection type
Returns:
java.lang.String
Throws:
ECSystemException

populate

public void populate()
              throws java.lang.Exception
Populates the databean. You should have everything you require from requestProperties and commandContext before this method is executed. Populates all nodes information and appends to the nodeInfo vector, which will later be retrieved by a caller data bean through the getNodeInfo() method.
Specified by:
populate in interface SmartDataBean
Throws:
java.lang.Exception

setCommandContext

public void setCommandContext(CommandContext cc)
Set the command context
Specified by:
setCommandContext in interface SmartDataBean
Parameters:
cc - The command context..

setRequestProperties

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

getStoreIds

public java.lang.String getStoreIds()
                             throws java.lang.Exception
Get 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.

getStoreId

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

getDefaultLanguageId

public java.lang.String getDefaultLanguageId()
                                      throws java.lang.Exception
Get 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
Get 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.