com.sapportals.portal.navigation
Interface INavigationNode

public interface INavigationNode

Title: Navigation Node Description: Interface representing a single node in the Navigation module. Copyright: Copyright (c) 2002 Company: SAP

Version:

1.0

Method Summary

boolean	contains(INavigationNode node) Check if node contains the node recieved as an argument (if merged using merge ID) or if similar to it.
boolean	contains(java.lang.String nodeName)
java.lang.Object	getAttributeValue(java.lang.String attributeName) Retrieves an attribute value from the connector node.
java.lang.Object	getAttributeValue(java.lang.String attributeName, java.util.Locale locale) Retrieves an attribute value from the connector node, according to the given locale.
NavigationNodes	getChildren() Retrieves a list of node's children.
NavigationNodes	getChildrenBeforeMerge()
NavigationNodes	getChildrenWithInivisible() Retrieves a list of node's children, including nodes that are invisible.
java.lang.String	getDescription(java.util.Locale locale) Retrieves the Description of the node (to be displayed in the navigation UI, if needed).
int	getDragRelate() Retrieves a value defining whether the node is Drag & Relate target.
java.lang.String	getDropJScript() Retrieves the script that needs to be executed when droping a link on the node.
java.lang.String	getDropJScriptId() Retrieves the ID of the JavaScript code returned in getDragJScript() (for optimizations).
java.lang.String	getDropPRTEvent() Retrieves the PRT event that should be added to the iView's URL in case of a drop event.
int	getExtWindowHeight() Retrieves the height of the external window if node is defined to launch externally.
int	getExtWindowWidth() Retrieves the width of the external window if node is defined to launch externally.
INavigationNode	getFirstChild() Retrieves only the first child of the node.
java.lang.String	getLaunchURL() Retrieves the URL for launching the node.
java.lang.String	getMergeID() Retrieves the id for merging the node with other siblings
java.lang.String	getName() Retrieves the name of the node.
java.lang.String	getNavConnectorNamePrefix() Retrieves the node's navigation connector name prefix.
double	getPriority() Retrieves the priority of the node that allows sorting tabs etc.
javax.naming.NamingEnumeration	getRelatedNavigationEntities() Retrieves a list of nodes having NAVIGATION_GET_RELATED_NAV_ENTITIES relation with the node.
NavigationNodes	getRelatedSeeAlsoNodes() Retrieves a list of nodes having NAVIGATION_GET_RELATED_SEE_ALSO relation with the node.
NavigationNodes	getRelatedTargetNodes() Retrieves a list of nodes having NAVIGATION_GET_RELATED_DR_TARGETS relation with the node.
int	getShowType() Retrieves a value indicating whether the node is to be launched in external window (SHOW_EXTERNAL) or in the portal framework page (SHOW_INPLACE).
java.lang.String	getTitle(java.util.Locale locale) Retrieves the title of the node (to be displayed in the navigation UI).
int	getVisualizationType() Retrieves the visualization type for this Node.
java.lang.String	getWindowName() Retrieves the window Name in which the node will be launched if launched externally.
boolean	hasChildren() Return true is this navigation node has children and false otherwise.
boolean	isLaunchable() Retrieves flag indicating whether the node can be launched.
boolean	isMergible() Retrieves flag indicating whether the node can be merged.
javax.naming.NamingEnumeration	listBindings(java.lang.String name, java.lang.String mode) Enumerates the names bound in the named context, along with the objects bound to them.

Method Detail

getAttributeValue

public java.lang.Object getAttributeValue(java.lang.String attributeName)
                                   throws javax.naming.directory.NoSuchAttributeException

Retrieves an attribute value from the connector node.

Parameters:

attributeName - the attribute name for retrieval.

getAttributeValue

public java.lang.Object getAttributeValue(java.lang.String attributeName,
                                          java.util.Locale locale)
                                   throws javax.naming.directory.NoSuchAttributeException

Retrieves an attribute value from the connector node, according to the given locale.

Parameters:

attributeName - the attribute name for retrieval.

locale - locale requested for the attribute.

getTitle

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

Retrieves the title of the node (to be displayed in the navigation UI).

Parameters:

locale - locale requested for the title.

Returns:

title of the node.

getDescription

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

Retrieves the Description of the node (to be displayed in the navigation UI, if needed).

Parameters:

locale - locale requested for the Description.

Returns:

description of the node.

getName

public java.lang.String getName()

Retrieves the name of the node. The name include a navigation connector key prefix and the internal URL of the navigation connector.

Returns:

the name of the node.

listBindings

public javax.naming.NamingEnumeration listBindings(java.lang.String name,
                                                   java.lang.String mode)
                                            throws javax.naming.NamingException

Enumerates the names bound in the named context, along with the objects bound to them.

Parameters:

name - the name of the context to list.

mode - defining the relation between the node and the requested nodes list.

Returns:

enumeration of names and objects of nodes related to the node in the mode argument value.

getChildren

public NavigationNodes getChildren()
                            throws javax.naming.NamingException

Retrieves a list of node's children.

Returns:

children list of node's children.

Throws:

javax.naming.NamingException - If naming operation while looking for children throws exception.

getChildrenWithInivisible

public NavigationNodes getChildrenWithInivisible()
                                          throws javax.naming.NamingException

Retrieves a list of node's children, including nodes that are invisible.

Returns:

children list of node's children.

Throws:

javax.naming.NamingException - If naming operation while looking for children throws exception.

getChildrenBeforeMerge

public NavigationNodes getChildrenBeforeMerge()
                                       throws javax.naming.NamingException

hasChildren

public boolean hasChildren()
                    throws javax.naming.NamingException

Return true is this navigation node has children and false otherwise.

Returns:

boolean indicates whether this node has children.

Throws:

javax.naming.NamingException - If naming operation while looking for children throws exception.

getFirstChild

public INavigationNode getFirstChild()
                              throws javax.naming.NamingException

Retrieves only the first child of the node.

Returns:

INavigationNode the first child of the node.

Throws:

javax.naming.NamingException - If naming operation while looking for children throws exception.

getRelatedSeeAlsoNodes

public NavigationNodes getRelatedSeeAlsoNodes()
                                       throws javax.naming.NamingException

Retrieves a list of nodes having NAVIGATION_GET_RELATED_SEE_ALSO relation with the node.

Returns:

list of nodes having NAVIGATION_GET_RELATED_SEE_ALSO relation with the node.

Throws:

javax.naming.NamingException - If naming operation while looking for nodes throws exception.

getRelatedTargetNodes

public NavigationNodes getRelatedTargetNodes()
                                      throws javax.naming.NamingException

Retrieves a list of nodes having NAVIGATION_GET_RELATED_DR_TARGETS relation with the node.

Returns:

list of nodes having NAVIGATION_GET_RELATED_DR_TARGETS relation with the node.

Throws:

javax.naming.NamingException - If naming operation while looking for nodes throws exception.

getRelatedNavigationEntities

public javax.naming.NamingEnumeration getRelatedNavigationEntities()
                                                            throws javax.naming.NamingException

Retrieves a list of nodes having NAVIGATION_GET_RELATED_NAV_ENTITIES relation with the node.

Returns:

list of units having NAVIGATION_GET_RELATED_NAV_ENTITIES relation with the code.

Throws:

javax.naming.NamingException - If naming operation while looking for nodes throws exception.

getPriority

public double getPriority()

Retrieves the priority of the node that allows sorting tabs etc.

Returns:

the priority of the node.

getVisualizationType

public int getVisualizationType()

Retrieves the visualization type for this Node. Types are defined in the INAvigationConstants interface.

Returns:

constant representing the default visualization for displaying the node.

isLaunchable

public boolean isLaunchable()

Retrieves flag indicating whether the node can be launched.

Returns:

whether the node can be launched.

getLaunchURL

public java.lang.String getLaunchURL()

Retrieves the URL for launching the node.

Returns:

URL for launching the node.

getDragRelate

public int getDragRelate()

Retrieves a value defining whether the node is Drag & Relate target. Returns either REGULAR_TARGET or DRAGANDRELATE_TARGET. Constants defined in the INavigationConstants interface.

Returns:

value defining whether the node is Drag & Relate target.

getDropJScript

public java.lang.String getDropJScript()
                                throws java.lang.UnsupportedOperationException

Retrieves the script that needs to be executed when droping a link on the node. This script would run on the JavaScript onDrop event.

Returns:

the Java script defined for the dragging event. null if no Jscript has been defined.

Throws:

java.lang.UnsupportedOperationException - if node does not support scripts for drop events.

getDropJScriptId

public java.lang.String getDropJScriptId()
                                  throws java.lang.UnsupportedOperationException

Retrieves the ID of the JavaScript code returned in getDragJScript() (for optimizations).

Returns:

the Java script id defined for the dragging event. null if no JScript has been defined.

Throws:

java.lang.UnsupportedOperationException - if node does not support scripts for drop events.

getDropPRTEvent

public java.lang.String getDropPRTEvent()
                                 throws java.lang.UnsupportedOperationException

Retrieves the PRT event that should be added to the iView's URL in case of a drop event.

Returns:

the PRT event that should be added to the iView's URL in case of a drop event.

Throws:

java.lang.UnsupportedOperationException - if node does not support scripts for drop events.

getShowType

public int getShowType()

Retrieves a value indicating whether the node is to be launched in external window (SHOW_EXTERNAL) or in the portal framework page (SHOW_INPLACE). The constants are located in the INavigationConstants interafce.

Returns:

whether the node is to be launched in external window or in the portal framework page.

isMergible

public boolean isMergible()

Retrieves flag indicating whether the node can be merged.

Returns:

whether the node can be merged.

getMergeID

public java.lang.String getMergeID()
                            throws java.lang.UnsupportedOperationException

Retrieves the id for merging the node with other siblings

Returns:

the id for merging the node with other siblings.

Throws:

java.lang.UnsupportedOperationException - if node does not support merging.

getWindowName

public java.lang.String getWindowName()
                               throws java.lang.UnsupportedOperationException

Retrieves the window Name in which the node will be launched if launched externally.

Returns:

the window Name in which the node will be launched.

Throws:

java.lang.UnsupportedOperationException - Window name is not supported or node defined to be launched in portal framework page.

getExtWindowHeight

public int getExtWindowHeight()
                       throws java.lang.UnsupportedOperationException

Retrieves the height of the external window if node is defined to launch externally. The measurment unit is pixel.

Returns:

the height of the external window if launched externally.

Throws:

java.lang.UnsupportedOperationException - width is not supported or node defined to be launched in place.

getExtWindowWidth

public int getExtWindowWidth()
                      throws java.lang.UnsupportedOperationException

Retrieves the width of the external window if node is defined to launch externally. The measurment unit is pixel.

Returns:

the width of the external window if launched externally.

Throws:

java.lang.UnsupportedOperationException - width is not supported or node defined to be launched in place.

getNavConnectorNamePrefix

public java.lang.String getNavConnectorNamePrefix()

Retrieves the node's navigation connector name prefix.

Returns:

node's navigation connector name prefix.

contains

public boolean contains(INavigationNode node)

Check if node contains the node recieved as an argument (if merged using merge ID) or if similar to it.

Parameters:

node - navigation node for checking (result of merging operation done using the merge ID of the nodes).

Returns:

true node is contained in object or similar to it false node is not contained in object and not similar to it

contains

public boolean contains(java.lang.String nodeName)