com.sapportals.portal.navigation

Interface INavigationNode

public interface INavigationNode

The interface that represents a single node in the navigation model.

Method Summary

boolean	contains(INavigationNode node) Checks if the node contains the specified node as a result of a merge operation.
boolean	contains(String nodeName) Checks if the node contains the specified node as a result of a merge operation.
NavigationNodes	getAllCollections(Hashtable filterParameters) Gets all visible collections attached to the node.
NavigationNodes	getAllExternalIviews(Hashtable filterParameters) Gets all external iViews attached to the node.
Object	getAttributeValue(String attributeName) Gets an attribute value from the connector node.
Object	getAttributeValue(String attributeName, Locale locale) Gets an attribute value from the connector node, according to the specified locale.
NavigationNodes	getChildren() Deprecated. use getChildren(Hashtable filterParameters)
NavigationNodes	getChildren(Hashtable filterParameters) Gets a list of the node's children.
NavigationNodes	getChildrenBeforeMerge() Deprecated. use getChildrenBeforeMerge(Hashtable filterParameters)
NavigationNodes	getChildrenBeforeMerge(Hashtable filterParameters) Gets a list of the node's children without merging them.
NavigationNodes	getChildrenWithInivisible() Deprecated. use getChildrenWithInivisible(Hashtable filterParameters)
NavigationNodes	getChildrenWithInivisible(Hashtable filterParameters) Gets a list of the node's children including nodes that are invisible.
INavigationNode	getCollection(String collectionName) Gets the specified collection node attached to the node.
INavigationNode	getDefaultNode() Deprecated. use getDefaultNode(Hashtable filterParameters); throws exception.
INavigationNode	getDefaultNode(Hashtable filterParameters) Retrieves the default node for this node.
String	getDescription(Locale locale) Gets the description of the node to be displayed in the navigation user interface.
int	getDragRelate() Indicates whether the node is a Drag&Relate target.
String	getDropJScript() Gets the script to execute when droping a link on the node.
String	getDropJScriptId() Gets the ID of the JavaScript code returned in getDropJScript.
String	getDropPRTEvent() Gets the PRT event to add to the iView URL for a drop event.
INavigationNode	getExternalIview(String externalIviewName) Gets the specified external iView node attached to the node.
int	getExtWindowHeight() Gets the height of the external window if the node is defined to launch externally.
int	getExtWindowWidth() Gets the width of the external window if the node is defined to launch externally.
INavigationNode	getFirstChild() Deprecated. use getFirstChild(Hashtable filterParameters)
INavigationNode	getFirstChild(Hashtable filterParameters) Gets the first child of the node.
String	getHashedName() Gets the hash representation of the full name of the node.
String	getLaunchURL() Gets the URL for launching the node.
String	getMergeID() Gets the ID for merging the node with other siblings.
String	getName() Gets the name of the node.
String	getNavConnectorNamePrefix() Gets the node's navigation connector name prefix.
double	getPriority() Gets the priority of the node for sorting.
NamingEnumeration	getRelatedNavigationEntities() Deprecated. use
NamingEnumeration	getRelatedNavigationEntities(Hashtable filterParameters) Gets a list of nodes that have a NAVIGATION_GET_RELATED_NAV_ENTITIES relationship with the node.
NavigationNodes	getRelatedNavigationEntitiesNodes() Deprecated. use
NavigationNodes	getRelatedNavigationEntitiesNodes(Hashtable filterParameters) Gets a list of nodes that have NAVIGATION_GET_RELATED_NAV_ENTITIES relation with the node.
NavigationNodes	getRelatedSeeAlsoNodes() Deprecated. use getRelatedSeeAlsoNodes(Hashtable filterParameters)
NavigationNodes	getRelatedSeeAlsoNodes(Hashtable filterParameters) Gets a list of nodes that have a NAVIGATION_GET_RELATED_SEE_ALSO relationship with the node.
NavigationNodes	getRelatedTargetNodes() Deprecated. use getRelatedTargetNodes(Hashtable filterParameters)
NavigationNodes	getRelatedTargetNodes(Hashtable filterParameters) Gets a list of nodes that have a NAVIGATION_GET_RELATED_DR_TARGETS relationship with the node.
int	getShowType() Indicates whether the node is to be launched in an external window or in the portal framework page.
String	getTitle(Locale locale) Gets the title of the node to be displayed in the navigation user interface.
int	getVisualizationType() Gets the visualization type for the node.
String	getWindowName() Gets the window name in which the node is launched if launched externally.
boolean	hasChildren() Deprecated. use hasChildren(Hashtable filterParameters)
boolean	hasChildren(boolean FilterInvisibles)
boolean	hasChildren(Hashtable filterParameters) Indicates whether the navigation node has children.
boolean	hasChildren(Hashtable filterParameters, boolean FilterInvisibles)
boolean	isLaunchable() Deprecated. use isLaunchable(Hashtable environment);
boolean	isLaunchable(Hashtable environment) Indicates whether the node can be launched.
boolean	isMergible() Indicates whether the node can be merged.
NamingEnumeration	listBindings(String name, String mode) Enumerates the names bound in the named context, along with the objects bound to them.

Method Detail

getAttributeValue

Object getAttributeValue(String attributeName)
                         throws NoSuchAttributeException

Gets an attribute value from the connector node.

Parameters:

attributeName - an attribute name

Returns:

the value of the attribute

Throws:

NoSuchAttributeException - if the attribute does not exist

getAttributeValue

Object getAttributeValue(String attributeName,
                         Locale locale)
                         throws NoSuchAttributeException

Gets an attribute value from the connector node, according to the specified locale.

Parameters:

attributeName - an attribute name

locale - the locale

Returns:

the value of the attribute

Throws:

NoSuchAttributeException - if the attribute does not exist

getTitle

String getTitle(Locale locale)

Gets the title of the node to be displayed in the navigation user interface.

Parameters:

locale - the locale

Returns:

the title of the node

getDescription

String getDescription(Locale locale)

Gets the description of the node to be displayed in the navigation user interface.

Parameters:

locale - the locale

Returns:

the description of the node

getName

String getName()

Gets the name of the node. The name includes a navigation connector key prefix and the internal URL of the navigation connector.

Returns:

the name of the node

getHashedName

String getHashedName()

Gets the hash representation of the full name of the node. The hash name includes the hash prefix.

Returns:

the hashed name of the node

listBindings

NamingEnumeration listBindings(String name,
                               String mode)
                               throws 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 - the type of node to return

Returns:

the enumeration of names and objects of nodes specified by the mode

Throws:

NamingException

getChildren

NavigationNodes getChildren()
                            throws NamingException

Deprecated. use getChildren(Hashtable filterParameters)

Gets a list of the node's children.

Returns:

children a list of the node's children

Throws:

NamingException - if the children could not be found

getChildren

NavigationNodes getChildren(Hashtable filterParameters)
                            throws NamingException

Gets a list of the node's children.

Parameters:

filterParameters - user information and a navigation target list, where the key is NavigationPrincipal (IUser) and NavigationTarget (String)

Returns:

a list of the node's children

Throws:

NamingException - if the children could not be found

getChildrenWithInivisible

NavigationNodes getChildrenWithInivisible()
                                          throws NamingException

Deprecated. use getChildrenWithInivisible(Hashtable filterParameters)

Gets a list of the node's children including nodes that are invisible.

Returns:

a list of the node's children

Throws:

NamingException - if the children could not be found

getChildrenWithInivisible

NavigationNodes getChildrenWithInivisible(Hashtable filterParameters)
                                          throws NamingException

Gets a list of the node's children including nodes that are invisible.

Parameters:

filterParameters - user information and a navigation target list, where the key is NavigationPrincipal (IUser) and NavigationTarget (String)

Returns:

a list of the node's children

Throws:

NamingException - if the children could not be found

getChildrenBeforeMerge

NavigationNodes getChildrenBeforeMerge()
                                       throws NamingException

Deprecated. use getChildrenBeforeMerge(Hashtable filterParameters)

Gets a list of the node's children without merging them.

Returns:

a list of the node's children.

Throws:

NamingException - if the children could not be found

getChildrenBeforeMerge

NavigationNodes getChildrenBeforeMerge(Hashtable filterParameters)
                                       throws NamingException

Gets a list of the node's children without merging them.

Parameters:

filterParameters - user information and a navigation target list, where the key is NavigationPrincipal (IUser) and NavigationTarget (String)

Returns:

a list of node's children.

Throws:

NamingException - if the children could not be found

hasChildren

boolean hasChildren()
                    throws NamingException

Deprecated. use hasChildren(Hashtable filterParameters)

Indicates whether the navigation node has children.

Returns:

true if the node has children, false if not

Throws:

NamingException - if the children could not be found

hasChildren

boolean hasChildren(Hashtable filterParameters)
                    throws NamingException

Indicates whether the navigation node has children.

Parameters:

filterParameters - user information and a navigation target list, where the key is NavigationPrincipal (IUser) and NavigationTarget (String)

Returns:

true if the node has children, false if not

Throws:

NamingException - if the children could not be found

hasChildren

boolean hasChildren(boolean FilterInvisibles)
                    throws NamingException

Throws:

NamingException

hasChildren

boolean hasChildren(Hashtable filterParameters,
                    boolean FilterInvisibles)
                    throws NamingException

Throws:

NamingException

getFirstChild

INavigationNode getFirstChild()
                              throws NamingException

Deprecated. use getFirstChild(Hashtable filterParameters)

Gets the first child of the node.

Returns:

INavigationNode the first child of the node

Throws:

NamingException - if the child could not be found

getFirstChild

INavigationNode getFirstChild(Hashtable filterParameters)
                              throws NamingException

Gets the first child of the node.

Parameters:

filterParameters - user information and a navigation target list, where the key is NavigationPrincipal (IUser) and NavigationTarget (String)

Returns:

the first child of the node

Throws:

NamingException - if the child could not be found

getDefaultNode

INavigationNode getDefaultNode()
                               throws NamingException

Deprecated. use getDefaultNode(Hashtable filterParameters); throws exception.

Retrieves the default node for this node. The default node should be used instead of the current in the navigation iViews.

Returns:

INavigationNode the default node of this node.

Throws:

NamingException - If naming operation while looking for the default node

getDefaultNode

INavigationNode getDefaultNode(Hashtable filterParameters)
                               throws NamingException

Retrieves the default node for this node. The default node should be used instead of the current in the navigation iViews.

Parameters:

filterParameters - contains the user information and the navigation target.

Returns:

INavigationNode the default node of this node.

Throws:

NamingException - If naming operation while looking for the default node throws exception.

getRelatedSeeAlsoNodes

NavigationNodes getRelatedSeeAlsoNodes()
                                       throws NamingException

Deprecated. use getRelatedSeeAlsoNodes(Hashtable filterParameters)

Gets a list of nodes that have a NAVIGATION_GET_RELATED_SEE_ALSO relationship with the node.

Returns:

a list of nodes

Throws:

NamingException - if the children could not be found

getRelatedSeeAlsoNodes

NavigationNodes getRelatedSeeAlsoNodes(Hashtable filterParameters)
                                       throws NamingException

Gets a list of nodes that have a NAVIGATION_GET_RELATED_SEE_ALSO relationship with the node.

Parameters:

filterParameters - user information and a navigation target list, where the key is NavigationPrincipal (IUser) and NavigationTarget (String)

Returns:

a list of nodes

Throws:

NamingException - if the children could not be found

getRelatedTargetNodes

NavigationNodes getRelatedTargetNodes()
                                      throws NamingException

Deprecated. use getRelatedTargetNodes(Hashtable filterParameters)

Gets a list of nodes that have a NAVIGATION_GET_RELATED_DR_TARGETS relationship with the node.

Returns:

a list of nodes

Throws:

NamingException - if the children could not be found

getRelatedTargetNodes

NavigationNodes getRelatedTargetNodes(Hashtable filterParameters)
                                      throws NamingException

Gets a list of nodes that have a NAVIGATION_GET_RELATED_DR_TARGETS relationship with the node.

Parameters:

filterParameters - user information and a navigation target list, where the key is NavigationPrincipal (IUser) and NavigationTarget (String)

Returns:

a list of nodes

Throws:

NamingException - if the children could not be found

getRelatedNavigationEntities

NamingEnumeration getRelatedNavigationEntities()
                                               throws NamingException

Deprecated. use

Gets a list of nodes that have a NAVIGATION_GET_RELATED_NAV_ENTITIES relationship with the node.

Returns:

a list of nodes

Throws:

NamingException - if the children could not be found

getRelatedNavigationEntities

NamingEnumeration getRelatedNavigationEntities(Hashtable filterParameters)
                                               throws NamingException

Gets a list of nodes that have a NAVIGATION_GET_RELATED_NAV_ENTITIES relationship with the node.

Parameters:

filterParameters - user information and a navigation target list, where the key is NavigationPrincipal (IUser) and NavigationTarget (String)

Returns:

a list of nodes

Throws:

NamingException - if the children could not be found

getRelatedNavigationEntitiesNodes

NavigationNodes getRelatedNavigationEntitiesNodes()
                                                  throws NamingException

Deprecated. use

Gets a list of nodes that have NAVIGATION_GET_RELATED_NAV_ENTITIES relation with the node.

Returns:

a list of nodes

Throws:

NamingException - if the children could not be found

getRelatedNavigationEntitiesNodes

NavigationNodes getRelatedNavigationEntitiesNodes(Hashtable filterParameters)
                                                  throws NamingException

Gets a list of nodes that have NAVIGATION_GET_RELATED_NAV_ENTITIES relation with the node.

Parameters:

filterParameters - user information and a navigation target list, where the key is NavigationPrincipal (IUser) and NavigationTarget (String)

Returns:

a list of nodes

Throws:

NamingException - if the children could not be found

getPriority

double getPriority()

Gets the priority of the node for sorting.

Returns:

the priority of the node

getVisualizationType

int getVisualizationType()

Gets the visualization type for the node. Types are defined in the interface.

Returns:

the default visualization type

isLaunchable

boolean isLaunchable()

Deprecated. use isLaunchable(Hashtable environment);

Indicates whether the node can be launched.

Returns:

true if the node is launchable, false if not

isLaunchable

boolean isLaunchable(Hashtable environment)

Indicates whether the node can be launched.

Parameters:

environment -

Returns:

true if the node is launchable, false if not

getLaunchURL

String getLaunchURL()

Gets the URL for launching the node.

Returns:

the URL for launching the node

getDragRelate

int getDragRelate()

Indicates whether the node is a Drag&Relate target.

Returns:

0 = regular target, 1 = Drag@Relate target

getDropJScript

String getDropJScript()
                      throws UnsupportedOperationException

Gets the script to execute when droping a link on the node. This script runs when the onDrop event is triggered.

Returns:

the JavaScript defined for the dragging event, null if no JavaScript has been defined

Throws:

UnsupportedOperationException - if the node does not support JavaScripts for drop events

getDropJScriptId

String getDropJScriptId()
                        throws UnsupportedOperationException

Gets the ID of the JavaScript code returned in getDropJScript.

Returns:

the JavaScript ID, null if no JavaScript is defined

Throws:

UnsupportedOperationException - if the node does not support JavaScripts for drop events

getDropPRTEvent

String getDropPRTEvent()
                       throws UnsupportedOperationException

Gets the PRT event to add to the iView URL for a drop event.

Returns:

the PRT event

Throws:

UnsupportedOperationException - if the node does not support JavaScripts for drop events

getShowType

int getShowType()

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

Returns:

0 = portal framework, 1 = external window

isMergible

boolean isMergible()

Indicates whether the node can be merged.

Returns:

true if the node can be merged, false if not

getMergeID

String getMergeID()
                  throws UnsupportedOperationException

Gets the ID for merging the node with other siblings.

Returns:

the merge ID

Throws:

UnsupportedOperationException - if the node does not support merging

getWindowName

String getWindowName()
                     throws UnsupportedOperationException

Gets the window name in which the node is launched if launched externally.

Returns:

the window name

Throws:

UnsupportedOperationException - if the window name is not supported or the node is defined to be launched in a portal framework page

getExtWindowHeight

int getExtWindowHeight()
                       throws UnsupportedOperationException

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

Returns:

the height of the external window

Throws:

UnsupportedOperationException - if height is not supported or the node is defined to be launched in a portal framework page

getExtWindowWidth

int getExtWindowWidth()
                      throws UnsupportedOperationException

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

Returns:

the width of the external window

Throws:

UnsupportedOperationException - if width is not supported or the node is defined to be launched in a portal framework page

getNavConnectorNamePrefix

String getNavConnectorNamePrefix()

Gets the node's navigation connector name prefix.

Returns:

the node's navigation connector name prefix

contains

boolean contains(INavigationNode node)

Checks if the node contains the specified node as a result of a merge operation.

Parameters:

node - a navigation node

Returns:

true if the node is contained in the object, false if not

contains

boolean contains(String nodeName)

Checks if the node contains the specified node as a result of a merge operation.

Parameters:

nodeName - a node name to check

Returns:

true if the node is contained in the object, false if not

getCollection

INavigationNode getCollection(String collectionName)
                              throws NamingException

Gets the specified collection node attached to the node.

Returns null if the specified collection does not exist.

Parameters:

collectionName - the collection name

Returns:

the specified collection node

Throws:

NamingException - if an exception occurred while looking up the nodes

getAllCollections

NavigationNodes getAllCollections(Hashtable filterParameters)
                                  throws NamingException

Gets all visible collections attached to the node.

Returns an empty List if no collections exist.

Parameters:

filterParameters - contains the user information and the navigation target

Returns:

all visible collections

Throws:

NamingException - if an exception occurred while looking up the nodes

getExternalIview

INavigationNode getExternalIview(String externalIviewName)
                                 throws NamingException

Gets the specified external iView node attached to the node.

Returns null if the external iView does not exist.

Parameters:

externalIviewName - a name of a set of external iViews

Returns:

the specified external iView node

Throws:

NamingException - if an exception occurred while looking up the nodes

getAllExternalIviews

NavigationNodes getAllExternalIviews(Hashtable filterParameters)
                                     throws NamingException

Gets all external iViews attached to the node.

Returns an empty enumeration if no external iView exists.

Parameters:

filterParameters - contains the user information and the navigation target

Returns:

all external iViews

Throws:

NamingException - if an exception occurred while looking up the nodes

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] EP-RUNTIME	[sap.com] tc/ep/navigation/api	api	EP-PIN