com.ibm.wps.portlet.menu
Interface MenuTreeInfoCopyCtrl

Deprecated. since 6.0. Support of the IBM portlet API may be removed in a future release of WebSphere Portal. Use of the Java Portlet API (javax.portlet) is recommended instead.

public interface MenuTreeInfoCopyCtrl

MenuTree providers choose to implement the MenuTreeInfoCopyCtrl interface if they support copying individual menu nodes to a different MenuTree implementation (ie if the tree is able to be the source of a copy operation). In order to support a per-node copy operation, the object returned by MenuProvider.getMenu(com.ibm.wps.portlet.menu.MenuContext) implements the MenuTreeInfoCopyCtrl interface besides the MenuTree interface. The object may use implementation specific knowledge about the nodes contained in the tree to perform a more efficient copy operation than it would be possible by only using well defined interfaces.

Since:

5.0

See Also:

MenuTreeInfoCtrl, MenuNode, MenuTree

Note:

This interface is designed to be implemented by clients.

Method Summary

void	copyNode(MenuNode dst, MenuTreeInfoCtrl dstTree, MenuNode src) Deprecated. Copies the node src into the dst node using the dstTree instance of the destination tree that exposes the MenuTreeInfoCtrl interface.

Method Detail

copyNode

void copyNode(MenuNode dst,
              MenuTreeInfoCtrl dstTree,
              MenuNode src)
              throws MenuTreeException

Deprecated.

Copies the node src into the dst node using the dstTree instance of the destination tree that exposes the MenuTreeInfoCtrl interface. The source controller copies the titles and descriptions in all available languages, and the action and parameters of the node. The node ID of the destination node is not changed. It may use implementation specific knowledge because the source node must be part of its own topology.

Parameters:

dst - destination node. After the copy operation the content of the destination node will be semantically equivalent to the content of the source node. The only difference is that the destination node belongs to a different topology.

dstTree - menu tree controller that the source can use to fill the destination node. This interface will be implemented by the destination MenuTree and provides the write operation to the destination node.

src - source node that must be a member of the menu tree the source menu tree controller is an interface of.

Throws:

MenuTreeException - if operation fails