com.sapportals.portal.navigation

Interface INavigationConnectorNode

All Superinterfaces:

INavigationConstants

All Known Implementing Classes:

AbstractNavigationConnectorNode

Deprecated. as of SP17, use by AbstractNavigationConnectorNode

public interface INavigationConnectorNode
extends INavigationConstants

The interface that defines a navigation connector node. Each connector implementation should use navigation connector nodes that implement this interface.

Field Summary

static String	NAVIGATION_DEFAULT_FOLDER_PAGE_ATTR Deprecated.
static String	NAVIGATION_GET_CHILDREN Deprecated.
static String	NAVIGATION_GET_FIRST_CHILD Deprecated.
static String	NAVIGATION_GET_RELATED_DR_TARGETS Deprecated.
static String	NAVIGATION_GET_RELATED_NAV_ENTITIES Deprecated.
static String	NAVIGATION_GET_RELATED_SEE_ALSO Deprecated.
static String	NAVIGATION_INVISIBLE_ATTR Deprecated.

Fields inherited from interface com.sapportals.portal.navigation.INavigationConstants

AFP, AFP_DEBUG_MODE, CACHE_DISCRIMINATOR_PARAM_NAME, CACHE_DURATION, CACHE_TTL, CNP_VIEW_TYPE, CONNECTOR_PREFIX, DEFAULT_AFTER_ALL, DEFAULT_BEFORE_ALL, DEFAULT_ENTRY_FOR_FOLDER, DESKTOP_TITLE_PARAM, DFLT, DISABLE_EVENT_NAVIGATION, DRAGANDRELATE_TARGET, DSM_NODE_NAME, DYNAMIC_TITLE_PARAM, ENV_PRINCIPAL, ENV_SAPPRIVATE_REQUESTPARAMS, EVENT_NAVIGATION, EXTERNAL_CONNECTOR_KEY, EXTERNAL_ITEM_SEPARATOR, EXTERNAL_NAME_END, EXTERNAL_NAME_PREFIX, EXTERNAL_NAME_START, FILTER_DESKTOP_ENABLED, FILTER_VIEW_ID_LIST, FRWK_TYPE, HASHED_URL, HASHED_URL_PREFIX, HISTORY_MODE_PARAM, HISTORY_PARAM_NAME, IGNORE_INITIAL_NODES_FILTER, IGNORE_NAVIGATION_CACHE_FLAG, IS_LEAF_ATTR, KEY_SEPERATOR, MERGE_PRIORITY, MERGED_ITEMS_SEPARATOR, MERGED_NAME_END, MERGED_NAME_START, NAV_MODE_PARAM, NAVIGATION_CONTEXT_ATTR, NAVIGATION_CONTEXT_PARAM, NAVIGATION_DOCKED_ATTR, NAVIGATION_EXTERNAL_CONNECTOR, NAVIGATION_GET_ALL_COLLECTIONS, NAVIGATION_GET_ALL_EXTERNAL_IVIEWS, NAVIGATION_GET_DEFAULT_NODE, NAVIGATION_HIERARCHY_METADATA_ATTR, NAVIGATION_HIERARCHY_METADATA_ATTR_CACHEABLE_VALUE, NAVIGATION_HIERARCHY_METADATA_ATTR_NON_CACHEABLE_VALUE, NAVIGATION_INVISIBLE_FALSE, NAVIGATION_INVISIBLE_TRUE, NAVIGATION_LEVELS_ATTRIBUTE, NAVIGATION_MECHANISM, NAVIGATION_PARAMETERS, NAVIGATION_PRINCIPAL, NAVIGATION_QUICKLINK, NAVIGATION_TARGET_ATTR, NAVIGATION_TARGET_PARAM, NAVIGATION_VIEW_ATTRIBUTE, NAVIGATION_VIEW_ATTRIBUTE_SEPARATOR, ON_DROP_EVENT_HANDLER, OPTIONAL_PREFIX_SEPARATOR, PERSONALIZE_PORTAL_MERGE_ID, PICTOGRAM_ATTR, PREVIOUS_NAVIGATION_TARGET, QUICKLINK_PARAM, REDIRECT_PREFIX_SEPARATOR, REGULAR_TARGET, RELATIVE_BASENAV_PARAM_NAME, RELATIVE_LEVELSUP_PARAM_NAME, RELATIVE_PATHLIST_PARAM_NAME, SEPARATOR, SHOW_EMBEDDED_EXTERNAL_HEADERLESS, SHOW_EXTERNAL, SHOW_EXTERNAL_HEADERLESS, SHOW_EXTERNAL_PORTAL, SHOW_HIDDEN, SHOW_INPLACE, SHOW_INPLACE_UNCHANGED_FRAMEWORK, SUPPORT_PERSONALIZE_INITIAL_NODES, SUPPORT_PERSONALIZE_INITIAL_NODES_ATTR, TABSET_ALL, TABSET_ID, TABSETS_ENABLED, TABSETS_MIN_SIZE, TYPE_ABSOLUTE_LINK, TYPE_COLLECTION, TYPE_ERROR, TYPE_EXTERNAL_IVIEW, TYPE_FOLDER, TYPE_IVIEW, TYPE_OBN_LINK, TYPE_OTHER, TYPE_PAGE, TYPE_RELATIVE_LINK, TYPE_WORKSET, URL_PREFIX_SEPARATOR, USED_CONNECTORS, USER_LOCALE, WINDOW_ID_PARAM

Method Summary

Object	getAttributeValue(String attributeName) Deprecated. Gets an attribute value from the connector node.
Object	getAttributeValue(String attributeName, Locale locale) Deprecated. Gets an attribute value from the connector node according to the specified locale.
String	getDescription(Locale locale) Deprecated. Gets the description of the node to be displayed in the navigation user interface according to the specified locale.
int	getDragRelate() Deprecated. Indicates whether the node is a Drag&Relate target.
int	getExtWindowHeight() Deprecated. Gets the height of the external window if the node is defined to launch externally.
int	getExtWindowWidth() Deprecated. Gets the width of the external window if the node is defined to launch externally.
String	getJScript(String mode) Deprecated. Gets the JavaScript to run when event described by the mode is triggered.
String	getJScriptId(String mode) Deprecated. Gets the ID of the JavaScript code returned in getJScript.
String	getLaunchURL(String nodeName) Deprecated. Gets the launch URL.
String	getMergeID() Deprecated. Gets the node's merge ID.
double	getPriority() Deprecated. Gets the priority of the node for sorting.
String	getPRTEvent(String mode) Deprecated. Gets the PRT event that corresponds with the mode.
int	getShowType() Deprecated. Indicates whether the node is to be launched in an external window or in the portal framework page.
String	getTitle(Locale locale) Deprecated. Gets the title of the node to be displayed in the navigation user interface according to the specified locale.
int	getVisualizationType() Deprecated. Gets the visualization type for the node.
String	getWindowName() Deprecated. Gets the window name in which the node is launched if launched externally.
boolean	isLaunchable() Deprecated. Indicates whether the node can be launched.
boolean	isMergible() Deprecated. Indicates whether the node can be merged.
NamingEnumeration	listBindings(String name, String mode) Deprecated. Enumerates the node names bound in the named context together with the objects bound to them.

Field Detail

NAVIGATION_GET_CHILDREN

static final String NAVIGATION_GET_CHILDREN

Deprecated.

See Also:

Constant Field Values

NAVIGATION_GET_FIRST_CHILD

static final String NAVIGATION_GET_FIRST_CHILD

Deprecated.

See Also:

Constant Field Values

NAVIGATION_GET_RELATED_SEE_ALSO

static final String NAVIGATION_GET_RELATED_SEE_ALSO

Deprecated.

See Also:

Constant Field Values

NAVIGATION_GET_RELATED_DR_TARGETS

static final String NAVIGATION_GET_RELATED_DR_TARGETS

Deprecated.

See Also:

Constant Field Values

NAVIGATION_GET_RELATED_NAV_ENTITIES

static final String NAVIGATION_GET_RELATED_NAV_ENTITIES

Deprecated.

See Also:

Constant Field Values

NAVIGATION_INVISIBLE_ATTR

static final String NAVIGATION_INVISIBLE_ATTR

Deprecated.

See Also:

Constant Field Values

NAVIGATION_DEFAULT_FOLDER_PAGE_ATTR

static final String NAVIGATION_DEFAULT_FOLDER_PAGE_ATTR

Deprecated.

See Also:

Constant Field Values

Method Detail

listBindings

NamingEnumeration listBindings(String name,
                               String mode)
                               throws NamingException

Deprecated.

Enumerates the node names bound in the named context together with the objects bound to them.

Parameters:

name - the name of the context to list

mode - the type of node

Returns:

an enumeration of names and objects of nodes

Throws:

NamingException

getAttributeValue

Object getAttributeValue(String attributeName)
                         throws NoSuchAttributeException

Deprecated.

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

Deprecated.

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

Parameters:

attributeName - an attribute name

locale - a locale

Returns:

the value of the attribute

Throws:

NoSuchAttributeException - if the attribute does not exist

isLaunchable

boolean isLaunchable()

Deprecated.

Indicates whether the node can be launched.

Returns:

true if the node can be launched, false if the node cannot be launched

getTitle

String getTitle(Locale locale)

Deprecated.

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

Parameters:

locale - a locale

Returns:

the title of the node

getDescription

String getDescription(Locale locale)

Deprecated.

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

Parameters:

locale - a locale

Returns:

the description of the node

getLaunchURL

String getLaunchURL(String nodeName)

Deprecated.

Gets the launch URL.

Returns:

the launch URL.

getPriority

double getPriority()

Deprecated.

Gets the priority of the node for sorting.

Returns:

the priority

getVisualizationType

int getVisualizationType()

Deprecated.

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

Returns:

the default visualization type

getDragRelate

int getDragRelate()

Deprecated.

Indicates whether the node is a Drag&Relate target.

Returns:

0 = regular target, 1 = Drag&Relate target

isMergible

boolean isMergible()

Deprecated.

Indicates whether the node can be merged.

Returns:

true if the node can be merged, false if it cannot be merged

getMergeID

String getMergeID()
                  throws UnsupportedOperationException

Deprecated.

Gets the node's merge ID. This value is used for merging navigation nodes.

Returns:

merge the ID value

Throws:

UnsupportedOperationException - if the node does not support merging

getJScript

String getJScript(String mode)
                  throws UnsupportedOperationException

Deprecated.

Gets the JavaScript to run when event described by the mode is triggered. Currently, only ON_DROP_EVENT_HANDLER is supported.

Parameters:

mode - the event this Java script handles

Returns:

the JavaScript defined for the dragging event, null if no JavaScript is defined

Throws:

UnsupportedOperationException

getJScriptId

String getJScriptId(String mode)
                    throws UnsupportedOperationException

Deprecated.

Gets the ID of the JavaScript code returned in getJScript.

Returns:

the JavaScript defined for the event, null if no JavaScript is defined

Throws:

UnsupportedOperationException

getPRTEvent

String getPRTEvent(String mode)
                   throws UnsupportedOperationException

Deprecated.

Gets the PRT event that corresponds with the mode. Used if a PRT event should be triggered in the URL built for the corresponding JavaScript returned by getJScript(java.lang.String) with the same mode. This method is only used the ON_DROP_EVENT_HANDLER mode.
The result of this method along with the specific call to trigger the PRT event is added to the URL which is created by getJScript.

Parameters:

mode - the type of node to return

Returns:

a PRT event

Throws:

UnsupportedOperationException - if the connector is not related to the PRT event

getShowType

int getShowType()

Deprecated.

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

getWindowName

String getWindowName()
                     throws UnsupportedOperationException

Deprecated.

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 launch in a portal framework page

getExtWindowHeight

int getExtWindowHeight()
                       throws UnsupportedOperationException

Deprecated.

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 launch in a portal framework page

getExtWindowWidth

int getExtWindowWidth()
                      throws UnsupportedOperationException

Deprecated.

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 launch in a portal framework page

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