com.ibm.wps.portlet.menu
Interface MenuNode

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 MenuNode

MenuNode represents the elements of a menu topology. It can be used to get information on the title, description, URL, etc for each node in a menu.

The tree model MenuTree provides methods to get information about the tree topology, i.e., which parent node has which child nodes, and return instances of MenuNode. The methods of MenuNode allow to view node-specific information, i.e.,

• Locale-dependent title and description for a specific locale
• Locale-dependent title and description for the locale of the current request, which is retrieved from MenuContext.
• Node ID and scope
• URL (=Universal Resource Locator) including action string and parameters. The method uses the current request, which is retrieved from MenuContext.

Since:

5.0

See Also:

MenuTree, MenuProvider

Note:

This interface is designed to be implemented by clients.

Field Summary

static int	SCOPE_GLOBAL Deprecated. The portlet-dependent tree will not change until the portlet is either deleted from the page, or the corresponding portlet application is updated or re-installed.
static int	SCOPE_REQUEST Deprecated. The menu tree of the portlet is user-specific and changes are reflected from request to request
static int	SCOPE_SESSION Deprecated. The tree is user-specific and the tree will not change as long as the user is logged in.

Method Summary

java.lang.String	getDescription() Deprecated. Returns description of the menu tree node for the locale of the current request.
java.lang.String	getDescription(java.util.Locale locale) Deprecated. Returns description of the menu tree node for a specific locale.
java.lang.String	getId() Deprecated. Returns ID of the menu tree node.
int	getScope() Deprecated. Returns scope of the menu tree node.
java.lang.String	getTitle() Deprecated. Returns title of the menu tree node for the locale of the current request.
java.lang.String	getTitle(java.util.Locale locale) Deprecated. Returns title of the menu tree node for a specific locale.
java.lang.String	getURL() Deprecated. Returns URL of the menu tree node.

Field Detail

SCOPE_REQUEST

static final int SCOPE_REQUEST

Deprecated.

The menu tree of the portlet is user-specific and changes are reflected from request to request

See Also:

MenuTreeTopologyCtrl.setScope(com.ibm.wps.portlet.menu.MenuNode, int), getScope(), Constant Field Values

SCOPE_SESSION

static final int SCOPE_SESSION

Deprecated.

The tree is user-specific and the tree will not change as long as the user is logged in.

See Also:

MenuTreeTopologyCtrl.setScope(com.ibm.wps.portlet.menu.MenuNode, int), getScope(), Constant Field Values

SCOPE_GLOBAL

static final int SCOPE_GLOBAL

Deprecated.

The portlet-dependent tree will not change until the portlet is either deleted from the page, or the corresponding portlet application is updated or re-installed.

See Also:

MenuTreeTopologyCtrl.setScope(com.ibm.wps.portlet.menu.MenuNode, int), getScope(), Constant Field Values

Method Detail

getId

java.lang.String getId()

Deprecated.

Returns ID of the menu tree node.

Returns:

node ID

See Also:

MenuTreeTopologyCtrl.addNode(java.lang.String, com.ibm.wps.portlet.menu.MenuNode), MemoryMenuService.getMenuTree(java.lang.String, com.ibm.wps.portlet.menu.MenuContext)

getTitle

java.lang.String getTitle()

Deprecated.

Returns title of the menu tree node for the locale of the current request. When the title is not available for the locale of the request, the method tries to provide a fallback title or returns null.

Returns:

node title

See Also:

MenuTreeInfoCtrl.setInformation(java.util.Locale, java.lang.String, java.lang.String, com.ibm.wps.portlet.menu.MenuNode)

getTitle

java.lang.String getTitle(java.util.Locale locale)

Deprecated.

Returns title of the menu tree node for a specific locale. Returns null if the title has not been set.

Parameters:

locale - locale

Returns:

node title

See Also:

MenuTreeInfoCtrl.setInformation(java.util.Locale, java.lang.String, java.lang.String, com.ibm.wps.portlet.menu.MenuNode)

getDescription

java.lang.String getDescription()

Deprecated.

Returns description of the menu tree node for the locale of the current request. When the description is not available for the locale of the request, the method tries to provide a fallback description or returns null.

Returns:

node description

See Also:

MenuTreeInfoCtrl.setInformation(java.util.Locale, java.lang.String, java.lang.String, com.ibm.wps.portlet.menu.MenuNode)

getDescription

java.lang.String getDescription(java.util.Locale locale)

Deprecated.

Returns description of the menu tree node for a specific locale. Returns null if the description has not been set.

Parameters:

locale - locale

Returns:

node description

See Also:

MenuTreeInfoCtrl.setInformation(java.util.Locale, java.lang.String, java.lang.String, com.ibm.wps.portlet.menu.MenuNode)

getURL

java.lang.String getURL()

Deprecated.

Returns URL of the menu tree node.

Returns:

URL (= Universal Resource Locator) of the menu tree node. The URL string may contain an action name and some parameters.

See Also:

MenuTreeInfoCtrl.setAction(java.lang.String, com.ibm.wps.portlet.menu.MenuNode), MenuTreeInfoCtrl.addActionParameter(java.lang.String, java.lang.String, com.ibm.wps.portlet.menu.MenuNode)

getScope

int getScope()

Deprecated.

Returns scope of the menu tree node.

Returns:

scope of the node which can have the following values: SCOPE_REQUEST, SCOPE_SESSION, and SCOPE_GLOBAL.

See Also:

MenuTreeTopologyCtrl.setScope(com.ibm.wps.portlet.menu.MenuNode, int)