com.sapportals.portal.navigation

Class AbstractNavigationConnectorNode

java.lang.Object

com.sapportals.portal.navigation.AbstractNavigationConnectorNode

All Implemented Interfaces:

INavigationConnectorNode, INavigationConstants

public abstract class AbstractNavigationConnectorNode
extends Object
implements INavigationConnectorNode

The base class that represents a navigation connector node.

A connector creates a tree of initial nodes, and each of these nodes is responsible for its own children (as defined in the listBindings method).

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAVIGATION_DEFAULT_FOLDER_PAGE_ATTR A constant that defines the PCD attribute name for a navigation default page for a folder.
static String	NAVIGATION_GET_CHILDREN A constant that defines a type that indicates that all the children of a specified node should be returned.
static String	NAVIGATION_GET_FIRST_CHILD A constant that defines a type that indicates that only the first child of a specified node should be returned (according to the sort priority, if one exists).
static String	NAVIGATION_GET_RELATED_DR_TARGETS A constant that defines a type that indicates that all the Drag&Relate targets of a specified node should be returned.
static String	NAVIGATION_GET_RELATED_NAV_ENTITIES A constant that defines a type that indicates that all the dynamic navigation iViews of a specified node should be returned.
static String	NAVIGATION_GET_RELATED_SEE_ALSO A constant that defines a type that indicates that all the related links of a specified node should be returned.
static String	NAVIGATION_INVISIBLE_ATTR A constant that defines the PCD attribute name for a navigation invisible page.
boolean	USE_OLD_INTERFACE For internal use.

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_FILTER_MODE, 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_EXCLUDED_ID_LIST, FILTER_VIEW_ID_LIST, FRWK_TYPE, HASHED_URL, HASHED_URL_PREFIX, HISTORY_MODE_PARAM, HISTORY_PARAM_NAME, ICON_URI, 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_LOCK, 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, SHOW_STANDARDS_EXTERNAL_HEADERLESS, SHOW_VIEWPORT_EXTERNAL_HEADERLESS, 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

Constructor Summary

Constructors

Constructor and Description
AbstractNavigationConnectorNode()

Method Summary

Modifier and Type	Method and Description
boolean	forCahceOnly() Allows the connector to insert objects to the cache
NamingEnumeration	getAllCollections() Gets all visible node collections attached to the node.
NamingEnumeration	getAllExternalIviews() Gets the all external iView nodes.
abstract Object	getAttributeValue(String attributeName) Gets an attribute value from the connector node.
abstract Object	getAttributeValue(String attributeName, Locale locale) Gets an attribute value from the connector node, according to the specified locale.
NamingEnumeration	getCollection(String collectionName) Gets the specified node collection attached to the node.
abstract String	getDescription(Locale locale) Gets the description of the node to be displayed in the navigation user interface according to the specified locale.
abstract int	getDragRelate() Indicates whether the node is a Drag&Relate target.
NamingEnumeration	getExternalIview(String externalIviewName) Gets the specified external iView node.
abstract int	getExtWindowHeight() Gets the height of the external window if the node is defined to launch externally.
abstract int	getExtWindowWidth() Gets the width of the external window if the node is defined to launch externally.
abstract String	getJScript(String mode) Gets the JavaScript to run when the event described by the mode is triggered.
abstract String	getJScriptId(String mode) Gets the ID of the JavaScript code returned in getJScript(java.lang.String).
abstract String	getLaunchURL(String nodeName) Gets the launch URL.
abstract String	getMergeID() Gets the node's merge ID.
abstract double	getPriority() Gets the priority of the node for sorting.
abstract String	getPRTEvent(String mode) Gets the PRT event that corresponds with the mode.
abstract int	getShowType() Indicates whether the node is to be launched in an external window (SHOW_EXTERNAL) or in the portal framework page (SHOW_INPLACE).
abstract String	getTitle(Locale locale) Gets the title of the node to be displayed in the navigation user interface according to the specified locale.
abstract int	getVisualizationType() Gets the visualization type for the node.
abstract String	getWindowName() Gets the window name in which the node is launched, if launched externally.
abstract boolean	isLaunchable() Indicates whether the node can be launched.
abstract boolean	isMergible() Indicates whether the node can be merged.
abstract NamingEnumeration	listBindings(String name, String mode) Deprecated. use listBindings(String name,String mode,Hashtable filterParameters)
NamingEnumeration	listBindings(String name, String mode, Hashtable filterParameters) Enumerates the names bound in the named context specified by the user information and a navigation target list.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NAVIGATION_GET_CHILDREN

public static final String NAVIGATION_GET_CHILDREN

A constant that defines a type that indicates that all the children of a specified node should be returned.

navigation.getChildren

See Also:

Constant Field Values

NAVIGATION_GET_FIRST_CHILD

public static final String NAVIGATION_GET_FIRST_CHILD

A constant that defines a type that indicates that only the first child of a specified node should be returned (according to the sort priority, if one exists).

navigation.getFirstChild

See Also:

Constant Field Values

NAVIGATION_GET_RELATED_SEE_ALSO

public static final String NAVIGATION_GET_RELATED_SEE_ALSO

A constant that defines a type that indicates that all the related links of a specified node should be returned.

navigation.getRelatedSeeAlso

See Also:

Constant Field Values

NAVIGATION_GET_RELATED_DR_TARGETS

public static final String NAVIGATION_GET_RELATED_DR_TARGETS

A constant that defines a type that indicates that all the Drag&Relate targets of a specified node should be returned.

navigation.getRelatedDRTargets

See Also:

Constant Field Values

NAVIGATION_GET_RELATED_NAV_ENTITIES

public static final String NAVIGATION_GET_RELATED_NAV_ENTITIES

A constant that defines a type that indicates that all the dynamic navigation iViews of a specified node should be returned.

navigation.getRelatedNavEntities

See Also:

Constant Field Values

NAVIGATION_INVISIBLE_ATTR

public static final String NAVIGATION_INVISIBLE_ATTR

A constant that defines the PCD attribute name for a navigation invisible page.

navigation.attributes.invisible

See Also:

Constant Field Values

NAVIGATION_DEFAULT_FOLDER_PAGE_ATTR

public static final String NAVIGATION_DEFAULT_FOLDER_PAGE_ATTR

A constant that defines the PCD attribute name for a navigation default page for a folder.

com.sapportals.portal.navigation.FolderEntry

See Also:

Constant Field Values

USE_OLD_INTERFACE

public boolean USE_OLD_INTERFACE

For internal use.

false

Constructor Detail

AbstractNavigationConnectorNode

public AbstractNavigationConnectorNode()

Method Detail

listBindings

public abstract NamingEnumeration listBindings(String name,
                                               String mode)
                                        throws NamingException

Deprecated. use listBindings(String name,String mode,Hashtable filterParameters)

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

Specified by:

listBindings in interface INavigationConnectorNode

Parameters:

name - the name of the context

mode - the type of node to return

Returns:

an enumeration of names and objects of nodes as specified by the mode parameter

Throws:

NamingException

listBindings

public NamingEnumeration listBindings(String name,
                                      String mode,
                                      Hashtable filterParameters)
                               throws NamingException

Enumerates the names bound in the named context specified by the user information and a navigation target list.

Parameters:

name - the name of the context

mode - the type of node to return

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

Returns:

an enumeration of names and objects as specified by the mode parameter

Throws:

NamingException

getAttributeValue

public abstract Object getAttributeValue(String attributeName)
                                  throws NoSuchAttributeException

Gets an attribute value from the connector node.

Specified by:

getAttributeValue in interface INavigationConnectorNode

Parameters:

attributeName - the attribute name

Returns:

the value of the attribute

Throws:

NoSuchAttributeException - if the attribute does not exist

getAttributeValue

public abstract Object getAttributeValue(String attributeName,
                                         Locale locale)
                                  throws NoSuchAttributeException

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

Specified by:

getAttributeValue in interface INavigationConnectorNode

Parameters:

attributeName - an attribute name

locale - a locale

Returns:

the attribute value

Throws:

NoSuchAttributeException - if the attribute does not exist

isLaunchable

public abstract boolean isLaunchable()

Indicates whether the node can be launched.

Specified by:

isLaunchable in interface INavigationConnectorNode

Returns:

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

getTitle

public abstract String getTitle(Locale locale)

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

Specified by:

getTitle in interface INavigationConnectorNode

Parameters:

locale - a locale

Returns:

the title of the node

getDescription

public abstract String getDescription(Locale locale)

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

Specified by:

getDescription in interface INavigationConnectorNode

Parameters:

locale - a locale

Returns:

the description of the node

getLaunchURL

public abstract String getLaunchURL(String nodeName)

Gets the launch URL.

Specified by:

getLaunchURL in interface INavigationConnectorNode

Parameters:

nodeName - the full name of the node

Returns:

the launch URL

getPriority

public abstract double getPriority()

Gets the priority of the node for sorting.

Specified by:

getPriority in interface INavigationConnectorNode

Returns:

the priority value

getVisualizationType

public abstract int getVisualizationType()

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

Specified by:

getVisualizationType in interface INavigationConnectorNode

Returns:

the default visualization type

getDragRelate

public abstract int getDragRelate()

Indicates whether the node is a Drag&Relate target.

Specified by:

getDragRelate in interface INavigationConnectorNode

Returns:

0 = regular target, 1 = Drag&Relate target

isMergible

public abstract boolean isMergible()

Indicates whether the node can be merged.

Specified by:

isMergible in interface INavigationConnectorNode

Returns:

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

getMergeID

public abstract String getMergeID()
                           throws UnsupportedOperationException

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

Specified by:

getMergeID in interface INavigationConnectorNode

Returns:

merge ID value

Throws:

UnsupportedOperationException - if the node does not support merging

getJScript

public abstract String getJScript(String mode)
                           throws UnsupportedOperationException

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

Specified by:

getJScript in interface INavigationConnectorNode

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

public abstract String getJScriptId(String mode)
                             throws UnsupportedOperationException

Gets the ID of the JavaScript code returned in getJScript(java.lang.String).

Specified by:

getJScriptId in interface INavigationConnectorNode

Returns:

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

Throws:

UnsupportedOperationException

getPRTEvent

public abstract String getPRTEvent(String mode)
                            throws UnsupportedOperationException

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.

Specified by:

getPRTEvent in interface INavigationConnectorNode

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

public abstract int getShowType()

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

Specified by:

getShowType in interface INavigationConnectorNode

Returns:

0 = portal framework, 1 = external window

getWindowName

public abstract String getWindowName()
                              throws UnsupportedOperationException

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

Specified by:

getWindowName in interface INavigationConnectorNode

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

public abstract int getExtWindowHeight()
                                throws UnsupportedOperationException

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

Specified by:

getExtWindowHeight in interface INavigationConnectorNode

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

public abstract int getExtWindowWidth()
                               throws UnsupportedOperationException

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

Specified by:

getExtWindowWidth in interface INavigationConnectorNode

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

getCollection

public NamingEnumeration getCollection(String collectionName)

Gets the specified node collection attached to the node.

Returns null if the collection does not exist.

Parameters:

collectionName -

Returns:

an enumeration of one INavigationConnectorNode, whose children are the nodes in the collection

getAllCollections

public NamingEnumeration getAllCollections()

Gets all visible node collections attached to the node.

Returns null if no collections exist.

Returns:

an enumeration of INavigationConnectorNode objects, each of which is a visible collection

getExternalIview

public NamingEnumeration getExternalIview(String externalIviewName)

Gets the specified external iView node.

Returns null if the specified external iView node does not exist.

Parameters:

externalIviewName - name of the external iView node

Returns:

an enumeration of one INavigationConnectorNode, which is the external iView node

getAllExternalIviews

public NamingEnumeration getAllExternalIviews()

Gets the all external iView nodes.

Returns null if no external iView exists.

Returns:

an enumeration of INavigationConnectorNode objects, each of which is an external iView node

forCahceOnly

public boolean forCahceOnly()

Allows the connector to insert objects to the cache

Returns:

true if this object will only be insert to the cache.