com.sapportals.portal.navigation
Interface INavigationConnectorNode

public interface INavigationConnectorNode

Title: Navigation Service Description: Service that coordinates the navigation Module Copyright: Copyright (c) 2002 Company: SAP

Version:

1.0

Field Summary

static java.lang.String	NAVIGATION_DEFAULT_FOLDER_PAGE_ATTR
static java.lang.String	NAVIGATION_GET_CHILDREN
static java.lang.String	NAVIGATION_GET_FIRST_CHILD
static java.lang.String	NAVIGATION_GET_RELATED_DR_TARGETS
static java.lang.String	NAVIGATION_GET_RELATED_NAV_ENTITIES
static java.lang.String	NAVIGATION_GET_RELATED_SEE_ALSO
static java.lang.String	NAVIGATION_INVISIBLE_ATTR

Method Summary

java.lang.Object	getAttributeValue(java.lang.String attributeName) retrieves am attribute 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.
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 target is Drag & Relate target.
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.
java.lang.String	getJScript(java.lang.String mode) retrieves the Java Script that needs to run when event described by the mode is fired.
java.lang.String	getJScriptId(java.lang.String mode) Retrieves the ID of the JavaScript code returned in getDragJScript(mode) (for optimizations).
java.lang.String	getLaunchURL(java.lang.String nodeName) retrieves the launch URL.
java.lang.String	getMergeID() Retrieves a value of the node's merge ID.
double	getPriority() returns the priority of the node that allows sorting tabs etc. coming from different repositories
java.lang.String	getPRTEvent(java.lang.String mode) Retrieves the PRT event that corresponds with the mode.
int	getShowType() Retrieves a value defining the node's show type. returns either SHOW_INPLACE or SHOW_EXTERNAL.
java.lang.String	getTitle(java.util.Locale locale) Retrieves the title of the node (to be displayed in the navigation UI).
int	getVisualizationType() returns the visualization type for this Node. e.g.
java.lang.String	getWindowName() Retrieves the window Name of the launched external window.
boolean	isLaunchable() returns whether the node can be launched.
boolean	isMergible() Retrieves a flag indicating whether 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.

Field Detail

NAVIGATION_GET_CHILDREN

public static final java.lang.String NAVIGATION_GET_CHILDREN

NAVIGATION_GET_FIRST_CHILD

public static final java.lang.String NAVIGATION_GET_FIRST_CHILD

NAVIGATION_GET_RELATED_SEE_ALSO

public static final java.lang.String NAVIGATION_GET_RELATED_SEE_ALSO

NAVIGATION_GET_RELATED_DR_TARGETS

public static final java.lang.String NAVIGATION_GET_RELATED_DR_TARGETS

NAVIGATION_GET_RELATED_NAV_ENTITIES

public static final java.lang.String NAVIGATION_GET_RELATED_NAV_ENTITIES

NAVIGATION_INVISIBLE_ATTR

public static final java.lang.String NAVIGATION_INVISIBLE_ATTR

NAVIGATION_DEFAULT_FOLDER_PAGE_ATTR

public static final java.lang.String NAVIGATION_DEFAULT_FOLDER_PAGE_ATTR

Method Detail

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.

getAttributeValue

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

retrieves am attribute 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.

isLaunchable

public boolean isLaunchable()

returns whether the node can be launched.

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.

getLaunchURL

public java.lang.String getLaunchURL(java.lang.String nodeName)

retrieves the launch URL.

Parameters:

nodeName - the full name of the node. This parameter can be used in order to generate the launch URL (for navigation connectors that the node's launch URL depends on the node's name).

Returns:

the launch URL.

getPriority

public double getPriority()

returns the priority of the node that allows sorting tabs etc. coming from different repositories

Returns:

the priority value.

getVisualizationType

public int getVisualizationType()

returns the visualization type for this Node. e.g. TYPE_IVIEW, TYPE_PAGE, TYPE_FOLDER

getDragRelate

public int getDragRelate()

Retrieves a value defining whether the target is Drag & Relate target. Returns either REGULAR_TARGET or DRAGANDRELATE_TARGET.

Returns:

value defining whether the target is Drag & Relate target

isMergible

public boolean isMergible()

Retrieves a flag indicating whether node can be merged.

getMergeID

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

Retrieves a value of the node's merge ID. This value is used for merging (mainly for display purposes) between navigation nodes.

Returns:

merge ID value.

getJScript

public java.lang.String getJScript(java.lang.String mode)
                            throws java.lang.UnsupportedOperationException

retrieves the Java Script that needs to run when event described by the mode is fired. Currently, ON_DROP_EVENT_HANDLER is only supported.

Parameters:

mode - defines what event is this Java script handles.

Returns:

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

getJScriptId

public java.lang.String getJScriptId(java.lang.String mode)
                              throws java.lang.UnsupportedOperationException

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

Returns:

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

getPRTEvent

public java.lang.String getPRTEvent(java.lang.String mode)
                             throws java.lang.UnsupportedOperationException

Retrieves the PRT event that corresponds with the mode. Used if a PRT event should be triggered in the URL built for the corresponding JScript returned by getJScript with the same mode.

Parameters:

mode - UnsupportedOperationException a connector that is not related to the PRT

Returns:

PRT event that corresponds with the mode.

getShowType

public int getShowType()

Retrieves a value defining the node's show type. returns either SHOW_INPLACE or SHOW_EXTERNAL.

Returns:

node's show type.

getWindowName

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

Retrieves the window Name of the launched external window. Is used only if the show type is SHOW_EXTERNAL.

Returns:

window Name of the launched external window.

Throws:

java.lang.UnsupportedOperationException - Window name cannnot be returned for inplace defined nodes.

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.