|
SAP NetWeaver 7.30 SP01 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface INavigationConstants
The interface that defines constants used in navigation operations.
| Field Summary | |
|---|---|
static String |
AFP
A constant that defines the Ajax Framework Page name AFP |
static String |
AFP_DEBUG_MODE
Indicates whether to load original AFP scripts or crunched AFP scripts |
static String |
CACHE_DISCRIMINATOR_PARAM_NAME
A constant that defines the parameter name of the cache connector discriminator on the request. |
static String |
CACHE_DURATION
A constant that defines the PCD attribute name for a cachable node. |
static String |
CACHE_TTL
A constant that defines the PCD attribute name for node cache TTL (in miliseconds). |
static String |
CNP_VIEW_TYPE
This parameter marking the navigation entry as a view ofa workcenter. |
static String |
CONNECTOR_PREFIX
A constant that defines the Connector Prefix name of a node. |
static String |
DEFAULT_AFTER_ALL
A constant that defines the Default Rerdirector that will run before all other redirectors com.sap.portal.navigation.DefaultAfterAll |
static String |
DEFAULT_BEFORE_ALL
A constant that defines the Default Rerdirector that will run before all other redirectors com.sap.portal.navigation.DefaultBeforeAll |
static String |
DEFAULT_ENTRY_FOR_FOLDER
A constant that defines the property name of the default entry for folder |
static String |
DESKTOP_TITLE_PARAM
|
static String |
DFLT
A constant that defines the Default Framework Page name Default |
static String |
DISABLE_EVENT_NAVIGATION
A constant that defines a request parameter that will disble the Event Based Navigation Mechanism. |
static int |
DRAGANDRELATE_TARGET
A constant that defines the target as a Drag&Relate target. |
static String |
DSM_NODE_NAME
A constant that defines the DSN portal node name com.sap.portal.dsm.DSMPortalNode |
static String |
DYNAMIC_TITLE_PARAM
|
static String |
ENV_PRINCIPAL
A constant that defines the user object key when adding a user to the environment hashtable. |
static String |
ENV_SAPPRIVATE_REQUESTPARAMS
|
static String |
EVENT_NAVIGATION
A constant that defines the parameter value of the Navigation Mechanism indicating that the Event Based Navigation wi9ll be used in this framework page. |
static String |
EXTERNAL_CONNECTOR_KEY
A constant that defines the parameter key for the external connector. |
static String |
EXTERNAL_ITEM_SEPARATOR
A constant that defines the separator between the navigation nodes in the external node name. |
static String |
EXTERNAL_NAME_END
A constant that defines the suffix for the external node name. |
static String |
EXTERNAL_NAME_PREFIX
A constant that defines the prefix for the external node name. |
static String |
EXTERNAL_NAME_START
A constant that defines the prefix for the external node name. |
static String |
FILTER_DESKTOP_ENABLED
Indicates whether desktop filter feature is enabled in NavigationEventsHelperService |
static String |
FILTER_VIEW_ID_LIST
Contains the value of Filter Id attribute defined on desktop |
static String |
FRWK_TYPE
A constant that defines the parameter name of the framework type on the request. |
static String |
HASHED_URL
The URL of the INavigationNode |
static String |
HASHED_URL_PREFIX
The prefix of hashed URLs |
static String |
HISTORY_MODE_PARAM
|
static String |
HISTORY_PARAM_NAME
A constant that defines the parameter name of the history service on the request. |
static String |
IGNORE_INITIAL_NODES_FILTER
Indicates NOT to filter initial nodes |
static String |
IGNORE_NAVIGATION_CACHE_FLAG
A constant that defines the flag to ignore the navigation cache for specific request. |
static String |
IS_LEAF_ATTR
A constant that defines the PCD attribute name for a is leaf. |
static String |
KEY_SEPERATOR
|
static String |
MERGE_PRIORITY
A constant that defines the PCD attribute name for a navigation merge priority. |
static String |
MERGED_ITEMS_SEPARATOR
A constant that defines the separator between the navigation nodes in the merged node name. |
static String |
MERGED_NAME_END
A constant that defines the suffix for the merged node name. |
static String |
MERGED_NAME_START
A constant that defines the prefix for the merged node name. |
static String |
NAV_MODE_PARAM
|
static String |
NAVIGATION_CONTEXT_ATTR
A constant that defines the PCD attribute name for a navigation context. |
static String |
NAVIGATION_CONTEXT_PARAM
|
static String |
NAVIGATION_DOCKED_ATTR
|
static String |
NAVIGATION_EXTERNAL_CONNECTOR
A constant that defines the PCD attribute name for an external connector com.sap.portal.navigation.ExternalConnector |
static String |
NAVIGATION_GET_ALL_COLLECTIONS
|
static String |
NAVIGATION_GET_ALL_EXTERNAL_IVIEWS
|
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_DEFAULT_NODE
Defines one of the listBinding API. |
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_HIERARCHY_METADATA_ATTR
A constant that defines the name of attribute on role,iview,page,folder etc ,this attribute represents metadata regarding the navigation hierarchy that can be configured for each portal object. |
static String |
NAVIGATION_HIERARCHY_METADATA_ATTR_CACHEABLE_VALUE
A constant that defines cacheable value for the attribute om.sap.portal.navigation.NavigationHierarchyMetadata Cacheable |
static String |
NAVIGATION_HIERARCHY_METADATA_ATTR_NON_CACHEABLE_VALUE
A constant that defines non-cacheable value for the attribute om.sap.portal.navigation.NavigationHierarchyMetadata Non-Cacheable |
static String |
NAVIGATION_INVISIBLE_ATTR
A constant that defines the PCD attribute name for an invisible navigation page. |
static String |
NAVIGATION_INVISIBLE_FALSE
A constant that defines the PCD attribute value that indicates false for the navigation invisible attribute. |
static String |
NAVIGATION_INVISIBLE_TRUE
A constant that defines the PCD attribute value that indicates true for the navigation invisible attribute. |
static String |
NAVIGATION_LEVELS_ATTRIBUTE
Contains the value of navigation levels attribute defined on semantic objects |
static String |
NAVIGATION_MECHANISM
A constant that defines the parameter name of the Navigation Mechanism to be used in a framework page. |
static String[] |
NAVIGATION_PARAMETERS
Constants that define the Navigation request parameters: all the request parameters that Navigation components can send |
static String |
NAVIGATION_PRINCIPAL
A constant that defines the user object key when adding a user to the environment hashtable. |
static String |
NAVIGATION_QUICKLINK
A constant that defines the PCD attribute name for a quick link. |
static String |
NAVIGATION_TARGET_ATTR
A constant that defines the PCD attribute name for a navigation target. |
static String |
NAVIGATION_TARGET_PARAM
|
static String |
NAVIGATION_VIEW_ATTRIBUTE
Contains the value of Filter Id attribute defined on entry points |
static String |
NAVIGATION_VIEW_ATTRIBUTE_SEPARATOR
Separator of Filter Id attribute defined on entry points |
static String |
ON_DROP_EVENT_HANDLER
A constant that defines a drag event handler. |
static String |
OPTIONAL_PREFIX_SEPARATOR
A constant that defines the second option for the URL separator between the connector prefix and the target URL. |
static String |
PERSONALIZE_PORTAL_MERGE_ID
A constant that defines the merge ID that indicates that the current page is to be displayed when the user wants to personalize the portal. |
static String |
PICTOGRAM_ATTR
A constant that defines the PCD attribute name for a pictogram. |
static String |
PREVIOUS_NAVIGATION_TARGET
A constant that defines the parameter name of the history service on the request. |
static String |
QUICKLINK_PARAM
A constant that defines the quick link parameter name. |
static String |
REDIRECT_PREFIX_SEPARATOR
A constant that defines the redirector separator between the redirector prefix and the target URL. |
static int |
REGULAR_TARGET
A constant that defines the target as a regular target. |
static String |
RELATIVE_BASENAV_PARAM_NAME
|
static String |
RELATIVE_LEVELSUP_PARAM_NAME
|
static String |
RELATIVE_PATHLIST_PARAM_NAME
|
static String |
SEPARATOR
|
static int |
SHOW_EMBEDDED_EXTERNAL_HEADERLESS
A constant that defines the launch mode of the navigation node. |
static int |
SHOW_EXTERNAL
A constant that defines the launch mode of the navigation node. |
static int |
SHOW_EXTERNAL_HEADERLESS
A constant that defines the launch mode of the navigation node. |
static int |
SHOW_EXTERNAL_PORTAL
A constant that defines the launch mode of the navigation node. |
static int |
SHOW_HIDDEN
Defines the launching mode of the navigation node. |
static int |
SHOW_INPLACE
A constant that defines the launch mode of the navigation node. |
static int |
SHOW_INPLACE_UNCHANGED_FRAMEWORK
A constant that defines the launch mode of the navigation node. |
static String |
SUPPORT_PERSONALIZE_INITIAL_NODES
|
static String |
SUPPORT_PERSONALIZE_INITIAL_NODES_ATTR
|
static String |
TABSET_ALL
This tabset includes all initial nodes |
static String |
TABSET_ID
TabsetId specified in request |
static String |
TABSETS_ENABLED
Indicates whether the tabsets feature is enabled |
static String |
TABSETS_MIN_SIZE
The minimal number of initial nodes required for displaying tabsets |
static int |
TYPE_ABSOLUTE_LINK
|
static int |
TYPE_COLLECTION
|
static int |
TYPE_ERROR
A constant that indicates that the navigation node is a Error type. |
static int |
TYPE_EXTERNAL_IVIEW
|
static int |
TYPE_FOLDER
A constant that indicates that the navigation node is a folder. |
static int |
TYPE_IVIEW
A constant that indicates that the navigation node is an iView. |
static int |
TYPE_OBN_LINK
|
static int |
TYPE_OTHER
A constant that indicates that the navigation node is a miscellaneous type. |
static int |
TYPE_PAGE
A constant that indicates that the navigation node is a page. |
static int |
TYPE_RELATIVE_LINK
|
static int |
TYPE_WORKSET
A constant that indicates that the navigation node is a workset. |
static String |
URL_PREFIX_SEPARATOR
A constant that defines the URL separator between the connector prefix and the target URL. |
static String |
USED_CONNECTORS
|
static String |
USER_LOCALE
|
static String |
WINDOW_ID_PARAM
|
| Field Detail |
|---|
static final int TYPE_IVIEW
0
static final int TYPE_PAGE
1
static final int TYPE_FOLDER
2
static final int TYPE_WORKSET
3
static final int TYPE_OTHER
4
static final int TYPE_EXTERNAL_IVIEW
static final int TYPE_COLLECTION
static final int TYPE_ABSOLUTE_LINK
static final int TYPE_RELATIVE_LINK
static final int TYPE_OBN_LINK
static final int TYPE_ERROR
5
static final String CNP_VIEW_TYPE
static final int SHOW_INPLACE
0
static final int SHOW_EXTERNAL
1
static final int SHOW_EXTERNAL_PORTAL
2
static final int SHOW_EXTERNAL_HEADERLESS
3
static final int SHOW_EMBEDDED_EXTERNAL_HEADERLESS
3
static final int SHOW_INPLACE_UNCHANGED_FRAMEWORK
static final int SHOW_HIDDEN
static final int REGULAR_TARGET
0
static final int DRAGANDRELATE_TARGET
1
static final String ON_DROP_EVENT_HANDLER
OnDragEventHandler
static final String URL_PREFIX_SEPARATOR
://
static final String OPTIONAL_PREFIX_SEPARATOR
:
static final String REDIRECT_PREFIX_SEPARATOR
:
static final String SEPARATOR
static final String KEY_SEPERATOR
static final String HASHED_URL_PREFIX
static final String HASHED_URL
static final String ENV_PRINCIPAL
NavigationPrincipal
static final String ENV_SAPPRIVATE_REQUESTPARAMS
static final String NAVIGATION_PRINCIPAL
NavigationPrincipal
static final String QUICKLINK_PARAM
QuickLink
static final String NAVIGATION_GET_CHILDREN
navigation.getChildren
static final String NAVIGATION_GET_RELATED_SEE_ALSO
navigation.getRelatedSeeAlso
static final String NAVIGATION_GET_RELATED_DR_TARGETS
navigation.getRelatedDRTargets
static final String NAVIGATION_GET_RELATED_NAV_ENTITIES
navigation.getRelatedNavEntities
static final String NAVIGATION_GET_FIRST_CHILD
navigation.getFirstChild
static final String NAVIGATION_GET_DEFAULT_NODE
static final String NAVIGATION_GET_ALL_COLLECTIONS
static final String NAVIGATION_GET_ALL_EXTERNAL_IVIEWS
static final String NAVIGATION_INVISIBLE_ATTR
navigation.attributes.invisibl
static final String NAVIGATION_INVISIBLE_TRUE
navigation.attributes.invisible.true
static final String NAVIGATION_INVISIBLE_FALSE
navigation.attributes.invisible.false
static final String NAVIGATION_TARGET_ATTR
navigation.attributes.NavigationTarget
static final String NAVIGATION_CONTEXT_ATTR
navigation.attributes.NavigationContext
static final String MERGE_PRIORITY
com.sap.portal.navigation.MergePriority
static final String PICTOGRAM_ATTR
com.sapportals.portal.navigation.Pictogram
static final String NAVIGATION_QUICKLINK
com.sap.portal.navigation.QuickLink
static final String IS_LEAF_ATTR
com.sap.portal.navigation.IsLeaf
static final String NAVIGATION_EXTERNAL_CONNECTOR
com.sap.portal.navigation.ExternalConnector
static final String DEFAULT_ENTRY_FOR_FOLDER
static final String PERSONALIZE_PORTAL_MERGE_ID
PORTAL_PERSONALIZATION
static final String MERGED_NAME_START
merge(
static final String MERGED_ITEMS_SEPARATOR
|
static final String MERGED_NAME_END
)
static final String NAVIGATION_TARGET_PARAM
static final String NAVIGATION_CONTEXT_PARAM
static final String DYNAMIC_TITLE_PARAM
static final String NAV_MODE_PARAM
static final String HISTORY_MODE_PARAM
static final String WINDOW_ID_PARAM
static final String RELATIVE_BASENAV_PARAM_NAME
static final String RELATIVE_LEVELSUP_PARAM_NAME
static final String RELATIVE_PATHLIST_PARAM_NAME
static final String CACHE_DURATION
navigation.attributes.CacheDuartion
static final String CACHE_TTL
navigation.attributes.CacheTTL
static final String CONNECTOR_PREFIX
navigation.attributes.ConnectorPrefix
static final String DSM_NODE_NAME
com.sap.portal.dsm.DSMPortalNode
static final String DEFAULT_BEFORE_ALL
com.sap.portal.navigation.DefaultBeforeAll
static final String DEFAULT_AFTER_ALL
com.sap.portal.navigation.DefaultAfterAll
static final String HISTORY_PARAM_NAME
com.sap.portal.navigation.HistoryList
static final String EXTERNAL_NAME_PREFIX
navext
static final String PREVIOUS_NAVIGATION_TARGET
com.sap.portal.navigation.HistoryList
static final String EXTERNAL_NAME_START
navext(
static final String EXTERNAL_ITEM_SEPARATOR
|
static final String EXTERNAL_NAME_END
)
static final String EXTERNAL_CONNECTOR_KEY
com.sap.portal.navigation.externalConnectorKey
static final String NAVIGATION_MECHANISM
com.sap.portal.navigation.navigationMechanism
static final String EVENT_NAVIGATION
EventBasedNavigation
static final String DISABLE_EVENT_NAVIGATION
disableEventBasedNavigation
static final String CACHE_DISCRIMINATOR_PARAM_NAME
com.sap.portal.navigation.cache.connector.discriminator
static final String IGNORE_NAVIGATION_CACHE_FLAG
com.sap.portal.navigation.cache.ignoreCacheFlag
static final String NAVIGATION_HIERARCHY_METADATA_ATTR
com.sap.portal.navigation.NavigationHierarchyMetadata
static final String NAVIGATION_HIERARCHY_METADATA_ATTR_CACHEABLE_VALUE
Cacheable
static final String NAVIGATION_HIERARCHY_METADATA_ATTR_NON_CACHEABLE_VALUE
Non-Cacheable
static final String NAVIGATION_LEVELS_ATTRIBUTE
static final String FILTER_DESKTOP_ENABLED
static final String FILTER_VIEW_ID_LIST
static final String NAVIGATION_VIEW_ATTRIBUTE
static final String NAVIGATION_VIEW_ATTRIBUTE_SEPARATOR
static final String USED_CONNECTORS
static final String SUPPORT_PERSONALIZE_INITIAL_NODES
static final String SUPPORT_PERSONALIZE_INITIAL_NODES_ATTR
static final String NAVIGATION_DOCKED_ATTR
static final String USER_LOCALE
static final String TABSET_ID
static final String TABSET_ALL
static final String TABSETS_ENABLED
static final String TABSETS_MIN_SIZE
static final String IGNORE_INITIAL_NODES_FILTER
static final String FRWK_TYPE
static final String AFP
AFP
static final String AFP_DEBUG_MODE
static final String DFLT
Default
static final String DESKTOP_TITLE_PARAM
static final String[] NAVIGATION_PARAMETERS
| Access Rights |
|---|
| SC | DC | Public Part | ACH |
|---|---|---|---|
[sap.com] EP-RUNTIME
|
[sap.com] tc/ep/navigation/api
|
api
|
EP-PIN
|
|
SAP NetWeaver 7.30 SP01 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||