com.ibm.commerce.tools.common.ui
Interface DynamicTreeUserDataBean

All Superinterfaces:
DataBean, InputDataBean, java.io.Serializable, SmartDataBean
All Known Implementing Classes:
ProductTreeDataBean

public interface DynamicTreeUserDataBean
extends SmartDataBean

Defines abstract methods which must be implemented by all dynamic tree user data beans.

These methods are called by DynamicTreeBean once the dynamic tree user data bean populate() method has been called.

DynamicTreeBean will then convert the data retrieved by these methods into JavaScript objects and return then to the client browser to be rendered into the tree.


Fields inherited from interface com.ibm.commerce.beans.SmartDataBean
COPYRIGHT
 
Fields inherited from interface com.ibm.commerce.beans.DataBean
emptyString
 
Method Summary
 java.util.Vector getIconInfo()
          Returns the icon type information for the dynamic tree node.
 java.util.Vector getMenuInfo()
          Returns the menu information for a dynamic tree node.
 java.util.Vector getNodeInfo()
          Returns the node(s) requested by the dynamic tree
 
Methods inherited from interface com.ibm.commerce.beans.SmartDataBean
getCommandContext, populate, setCommandContext
 
Methods inherited from interface com.ibm.commerce.beans.InputDataBean
getRequestProperties, setRequestProperties
 

Method Detail

getIconInfo

public java.util.Vector getIconInfo()
                             throws ECSystemException
Returns the icon type information for the dynamic tree node.

All icon types do not need to be defined when the tree first loads. Additional icon types can be defined along with children nodes, when a node is expanded.

Returns:
Vector A Vector of DynamicTreeIconType objects, which contain all the information relating to the various icon types created.
Throws:
ECSystemException - If an error occurs while trying to get the icon info.

getMenuInfo

public java.util.Vector getMenuInfo()
                             throws ECSystemException
Returns the menu information for a dynamic tree node.

All menus do not need to be defined when the tree first loads. When a tree nodes expands, appropriate menu types can be returned with the children nodes.

Returns:
A Vector of DynamicTreeMenuType objects, which contains all of the information about the menus available in the tree.
Throws:
ECSystemException - If an error occurs while trying to get the menu info.

getNodeInfo

public java.util.Vector getNodeInfo()
                             throws ECSystemException
Returns the node(s) requested by the dynamic tree
Returns:
The nodes to be included on the requested level of the tree.
Throws:
ECSystemException - If an error occurs while trying to get the node info.