
This interface provides services for dynamic navigation.
PREPARE_DYNAMIC_NAVIGATION
This method temporarily creates a navigation link.
This method creates a navigation link and a navigation target for the specified parameters. All the necessary view embeddings and view container assignments are created at the same time. If the target view comes from an embedded component, if necessary, the component usage is created. After this method has been called navigation can be performed by activating the outbound plug specified in SOURCE_PLUG_NAME.
Repeated calls to this method using the same outbound plug (SOURCE_PLUG_NAME) results in multiple navigation links being created to this outbound plug. As all these navigation links are followed during the navigation phase, this might cause a view other than the anticipated view to be displayed.
The following import parameters exist:
Name of the window in which the navigation is performed This is the window, in which the start and target views are embedded.
Name of the start view embedding
Name of the outbound plug
Name of the target component, that is the view to be displayed in the internal window.
Name of the target view to be navigated to
Name of the inbound plug
Embedding position of the view in the format:
[<View1>/ <Container1>.[<View2>/<Container2>]*].
If this parameter is set to initial, the view to be navigated to will be directly embedded in the window.
The following return parameters exist:
Reference to the component usage if the target view comes from an external component.
DO_DYNAMIC_NAVIGATION
This method creates a navigation link and performs the navigation.
To do this, the navigation link, navigation target, outbound plug, component usage, view embeddings, and view container components are created - provided that they do not already exist - for the navigation target. The navigation is then performed.
Repeated calls to this method using the same outbound plug (SOURCE_PLUG_NAME) results in multiple navigation links being created to this outbound plug. As all these navigation links are followed during the navigation phase, this might cause a view other than the anticipated view to be displayed.
The following import parameters exist:
Name of the window in which the navigation is performed This is the window, in which the start and target views are embedded.
Name of the start view embedding
Name of the outbound plug
Parameter list for custom events
Name of the target component, that is the view to be displayed in the internal window.
Name of the target view to be navigated to
Name of the inbound plug
Embedding position of the view in the format:
[<View1>/ <Container1>.[<View2>/<Container2>]*].
If this parameter is set to initial, the view to be navigated to will be directly embedded in the window.
The following return parameters exist:
Reference to the component usage if the view comes from an external component.
REMOVE_DYNAMIC_META_DATA
This method removes all dynamically created metadata (view embeddings, view container assignments, navigation links, navigation targets, component usages and outbound plugs) along the embedding path.
The following import parameters exist:
Name of the window in which the navigation is performed This is the window, in which the start and target views are embedded.
Name of the start view embedding
Name of the outbound plug
Name of the target component, that is the view to be displayed in the internal window.
Name of the target view to be navigated to
Name of the inbound plug
Embedding position of the view in the format:
[<View1>/ <Container1>.[<View2>/<Container2>]*].