SAP ABAP Class IF_WD_PORTAL_INTEGRATION (Web Dynpro: Portal Integration)
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | /UI2/CL_LAUNCHPAD_NAV_00 | Launchpad Navigation | 20111214 |
| 2 | Interface implementation (CLASS c. INTERFACES i_ref) | /UI2/CL_LAUNCHPAD_NAV_URL_01 | API to launch an application | 20120120 |
| 3 | Interface implementation (CLASS c. INTERFACES i_ref) | CL_APB_LPD_UNIT_TEST | Launchpad Unit Tests | 20100517 |
| 4 | Interface implementation (CLASS c. INTERFACES i_ref) | CL_WDR_PORTAL_INTEGRATION | Web Dynpro Runtime: Portal Integration | 20040716 |
Properties
| Class | IF_WD_PORTAL_INTEGRATION | |
| Short Description | Web Dynpro: Portal Integration | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | ||
| Created | 20040413 | SAP |
| Last change | 20130531 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 |  ABAP |
Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
| 2 | IF_WD_PORTAL_INTEGRATION |
Forward declaration interface (INTERFACE i DEFINITION DEF... | Forward declaration interface (INTERFACE i DEFINITION DEF... |
Interfaces
Class IF_WD_PORTAL_INTEGRATION has no interface implemented.
Friends
Class IF_WD_PORTAL_INTEGRATION has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CO_ALLOW_DUPLICATES |
Constant | Public | Type reference (TYPE) | STRING | '0' | Navigation Entry Can Occur Multiple Times in History | 20040716 | |
| 2 | CO_EVENT_SCOPE |
Constant | Public | See coding | 20080418 | ||||
| 3 | CO_NO_DUPLICATES |
Constant | Public | Type reference (TYPE) | STRING | '1' | Navigation Entry Can Occur Once in History | 20040716 | |
| 4 | CO_NO_HISTORY |
Constant | Public | Type reference (TYPE) | STRING | '2' | No Navigation Entry in History | 20040716 | |
| 5 | CO_RESOLVING_MODE |
Constant | Public | See coding | 20060207 | ||||
| 6 | CO_SHOW_EXTERNAL |
Constant | Public | Type reference (TYPE) | STRING | '1' | Navigation Target Is Displayed in New, External Window | 20040716 | |
| 7 | CO_SHOW_EXTERNAL_HEADERLESS |
Constant | Public | Type reference (TYPE) | STRING | '3' | Navigation target displayed in new, headerless portal window | 20080205 | |
| 8 | CO_SHOW_EXTERNAL_PORTAL |
Constant | Public | Type reference (TYPE) | STRING | '2' | Navigation Target Is Displayed in New,External Portal Window | 20040716 | |
| 9 | CO_SHOW_INPLACE |
Constant | Public | Type reference (TYPE) | STRING | '0' | Navigation Target Is Displayed in the Same Window | 20040716 | |
| 10 | CO_SHOW_INPLACE_UNCHANGED |
Constant | Public | Type reference (TYPE) | STRING | '5' | Navigation target displayed in same window, no TLN change | 20080205 | |
| 11 | CO_WP_MODE_APPLICATION_ONLY |
Constant | Public | Type reference (TYPE) | STRING | 'APPLICATION_ONLY' | Only Application Can Set the Dirty Flag | 20040805 | |
| 12 | CO_WP_MODE_BOTH |
Constant | Public | Type reference (TYPE) | STRING | 'BOTH' | Application and Runtime Can Set the Dirty Flag | 20040817 | |
| 13 | CO_WP_MODE_NONE |
Constant | Public | Type reference (TYPE) | STRING | 'NONE' | None Can Set the Dirty Flag | 20040805 | |
| 14 | M_DIRTY_FLAG |
Instance attribute | Public | Type reference (TYPE) | ABAP_BOOL | Status of Dirty Flag | 20040806 | ||
| 15 | M_PORTAL_TRAY_PERSONALIZE |
Instance attribute | Public | Type reference (TYPE) | ABAP_BOOL | Add Personalize Entry to Tray | 20050727 | ||
| 16 | M_PORTAL_VERSION |
Instance attribute | Public | Type reference (TYPE) | STRING | Portal Version | 20040802 | ||
| 17 | M_PORTAL_VERSION_MAJOR |
Instance attribute | Public | Type reference (TYPE) | STRING | Portal Version | 20040802 | ||
| 18 | M_PORTAL_VERSION_MINOR |
Instance attribute | Public | Type reference (TYPE) | STRING | Portal Version | 20040802 | ||
| 19 | M_WORK_PROTECT_MODE |
Instance attribute | Public | Type reference (TYPE) | STRING | Defines How Dirty Flag Can Be Set | 20040806 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | FIRE |
Instance method | Public | Method | Trigger Portal Event | 20040413 |
| 2 | NAVIGATE_ABSOLUTE |
Instance method | Public | Method | Navigation to Defined URL | 20040413 |
| 3 | NAVIGATE_RELATIVE |
Instance method | Public | Method | Navigation Relative to Own URL | 20040525 |
| 4 | NAVIGATE_TO_OBJECT |
Instance method | Public | Method | Navigation to Business Object | 20040413 |
| 5 | SET_APPLICATION_DIRTY_FLAG |
Instance method | Public | Method | Sets the Dirty Flag for Portal | 20040423 |
| 6 | SET_WORK_PROTECT_MODE |
Instance method | Public | Method | Sets Mode for Work Protect Mode | 20040806 |
| 7 | SUBSCRIBE_EVENT |
Instance method | Public | Method | Register Portal Event | 20040413 |
| 8 | UNSUBSCRIBE_EVENT |
Instance method | Public | Method | Delete Portal Event Registration | 20040413 |
Events
Class IF_WD_PORTAL_INTEGRATION has no event.
Types
Class IF_WD_PORTAL_INTEGRATION has no local type.
Method Signatures
Method FIRE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
PORTAL_EVENT_NAME | Call by reference | Type reference (TYPE) | STRING | 20040429 | |||
| 2 | Importing |
PORTAL_EVENT_NAMESPACE | Call by reference | Type reference (TYPE) | STRING | 20040429 | |||
| 3 | Importing |
PORTAL_EVENT_PARAMETER | Call by reference | Type reference (TYPE) | STRING | 20040429 | |||
| 4 | Importing |
PORTAL_EVENT_SCOPE | Call by reference | Type reference (TYPE) | STRING | IF_WD_PORTAL_INTEGRATION=>CO_EVENT_SCOPE-CURRENT_WINDOW | 20080418 |
Method FIRE on class IF_WD_PORTAL_INTEGRATION has no exception.
Method NAVIGATE_ABSOLUTE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
BUSINESS_PARAMETERS | Call by reference | Type reference (TYPE) | WDY_KEY_VALUE_LISTGEN | Parameterliste z.B. customerID=4711 für Ziel Applikation | 20040721 | ||
| 2 | Importing |
CONTEXT_URL | Call by reference | Type reference (TYPE) | STRING | der verwendete Navigationskontext | 20040413 | ||
| 3 | Importing |
HISTORY_MODE | Call by reference | Type reference (TYPE) | STRING | IF_WD_PORTAL_INTEGRATION=>CO_NO_DUPLICATES | Definiert, wie oft Navigationseintrag in Historie vorkommt | 20040413 | |
| 4 | Importing |
LAUNCHER_PARAMETERS | Call by reference | Type reference (TYPE) | WDY_KEY_VALUE_LISTGEN | Parameterliste z.B. WebDynproNamespace=myNamespace | 20040805 | ||
| 5 | Importing |
NAVIGATION_MODE | Call by reference | Type reference (TYPE) | STRING | IF_WD_PORTAL_INTEGRATION=>CO_SHOW_INPLACE | Navigation in gleiches oder externes Fenster | 20040413 | |
| 6 | Importing |
NAVIGATION_TARGET | Value transfer | Type reference (TYPE) | STRING | Die absolute Navigations URL | 20040413 | ||
| 7 | Importing |
POST_PARAMETERS | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | TRUE wenn mit POST gearbeitet werden soll, ansonsten GET | 20041004 | |
| 8 | Importing |
TARGET_TITLE | Call by reference | Type reference (TYPE) | STRING | Titel für die Portalseite | 20040413 | ||
| 9 | Importing |
USE_SAP_LAUNCHER | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | TRUE wenn Ziel mit SapLauncher aufgerufen wird z.B. BSP | 20040413 | |
| 10 | Importing |
WINDOW_FEATURES | Call by reference | Type reference (TYPE) | STRING | Zusätzliche Fenster-Eigenschaften (nur bei ext. Fenstern) | 20040413 | ||
| 11 | Importing |
WINDOW_NAME | Call by reference | Type reference (TYPE) | STRING | Name des externen Fensters | 20040413 |
Method NAVIGATE_ABSOLUTE on class IF_WD_PORTAL_INTEGRATION has no exception.
Method NAVIGATE_RELATIVE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
BASE_URL | Call by reference | Type reference (TYPE) | STRING | Startpunkt für die rel. Navigation. | 20040525 | ||
| 2 | Importing |
BUSINESS_PARAMETERS | Call by reference | Type reference (TYPE) | WDY_KEY_VALUE_LISTGEN | Liste von Business Parameter (NAME/VALUE) | 20040723 | ||
| 3 | Importing |
CONTEXT_URL | Call by reference | Type reference (TYPE) | STRING | verwendet Navigationskontext | 20040525 | ||
| 4 | Importing |
HISTORY_MODE | Call by reference | Type reference (TYPE) | STRING | IF_WD_PORTAL_INTEGRATION=>CO_NO_DUPLICATES | Definiert, wie oft Navigationseintrag in Historie vorkommt | 20040525 | |
| 5 | Importing |
LAUNCHER_PARAMETERS | Call by reference | Type reference (TYPE) | WDY_KEY_VALUE_LISTGEN | Liste von Applikation Parameter (NAME/VALUE) | 20040805 | ||
| 6 | Importing |
LEVELS_UP | Call by reference | Type reference (TYPE) | STRING | Anzahl der Navigationsschritte nach oben | 20040525 | ||
| 7 | Importing |
NAVIGATION_MODE | Call by reference | Type reference (TYPE) | STRING | IF_WD_PORTAL_INTEGRATION=>CO_SHOW_INPLACE | Navigation in gleiches oder externes Fenster | 20040525 | |
| 8 | Importing |
PATH | Call by reference | Type reference (TYPE) | STRING_TABLE | Liste der Knoten zu denen navigiert werden soll | 20040525 | ||
| 9 | Importing |
POST_PARAMETERS | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | TRUE wenn mit POST gearbeitet werden soll, ansonsten GET | 20050203 | |
| 10 | Importing |
TARGET_TITLE | Call by reference | Type reference (TYPE) | STRING | Titel für die Portalseite | 20040525 | ||
| 11 | Importing |
USE_SAP_LAUNCHER | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | Muß TRUE sein, wenn Ziel über SapLauncher aufgerufen wird | 20040525 | |
| 12 | Importing |
WINDOW_FEATURES | Call by reference | Type reference (TYPE) | STRING | Zusätzliche Fenster Eigenschaften (nur bei ext. Fenstern) | 20040525 | ||
| 13 | Importing |
WINDOW_NAME | Call by reference | Type reference (TYPE) | STRING | Name Fensters (nur bei ext. Fenstern) | 20040525 |
Method NAVIGATE_RELATIVE on class IF_WD_PORTAL_INTEGRATION has no exception.
Method NAVIGATE_TO_OBJECT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
BUSINESS_PARAMETERS | Call by reference | Type reference (TYPE) | WDY_KEY_VALUE_LISTGEN | Parameterliste z.B. customerID=4711 für Ziel Applikation | 20040726 | ||
| 2 | Importing |
FORWARD_OBN_METADATA | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | TRUE wenn die Metadaten für die OBN weitergeleitet werden | 20040817 | |
| 3 | Importing |
OBJECT_TYPE | Call by reference | Type reference (TYPE) | STRING | Typ des Business-Objektes | 20040817 | ||
| 4 | Importing |
OBJECT_VALUE | Call by reference | Type reference (TYPE) | STRING | Wert des Objekts | 20040429 | ||
| 5 | Importing |
OBJECT_VALUE_NAME | Call by reference | Type reference (TYPE) | STRING | 'objectValue' | Name mit dem der Objectwert übertragen wird | 20040429 | |
| 6 | Importing |
OPERATION | Call by reference | Type reference (TYPE) | STRING | Auszuführende Operation des Business-Objekts | 20040413 | ||
| 7 | Importing |
RESOLVING_MODE | Call by reference | Type reference (TYPE) | STRING | CO_RESOLVING_MODE-SOURCE_ROLE | Modus zur Auflösung der Rollen | 20060206 | |
| 8 | Importing |
SYSTEM | Call by reference | Type reference (TYPE) | STRING | System, das das Business-Objekt definiert | 20040413 | ||
| 9 | Importing |
USE_FORWARDPARAMETERS_OF_AL | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Use for appLauncher in Portal the parameter ForwardParameter | 20050803 |
Method NAVIGATE_TO_OBJECT on class IF_WD_PORTAL_INTEGRATION has no exception.
Method SET_APPLICATION_DIRTY_FLAG Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
DIRTY_FLAG | Call by reference | Type reference (TYPE) | WDY_BOOLEAN | TRUE = dirty / FALSE = not dirty | 20040805 |
Method SET_APPLICATION_DIRTY_FLAG on class IF_WD_PORTAL_INTEGRATION has no exception.
Method SET_WORK_PROTECT_MODE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
MODE | Call by reference | Type reference (TYPE) | STRING | WorkProtect-Modus NONE / BOTH / APPLICATION_ONLY | 20040806 |
Method SET_WORK_PROTECT_MODE on class IF_WD_PORTAL_INTEGRATION has no exception.
Method SUBSCRIBE_EVENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
ACTION | Call by reference | Type reference (TYPE) | STRING | Auszulösende Action | 20040413 | ||
| 2 | Importing |
PORTAL_EVENT_NAME | Call by reference | Type reference (TYPE) | STRING | Portal Event Name | 20040429 | ||
| 3 | Importing |
PORTAL_EVENT_NAMESPACE | Call by reference | Type reference (TYPE) | STRING | Portal Event Namespace | 20040429 | ||
| 4 | Importing |
VIEW | Call by reference | Object reference (TYPE REF TO) | IF_WD_VIEW_CONTROLLER | View | 20040413 |
Method SUBSCRIBE_EVENT on class IF_WD_PORTAL_INTEGRATION has no exception.
Method UNSUBSCRIBE_EVENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
PORTAL_EVENT_NAME | Call by reference | Type reference (TYPE) | STRING | 20040429 | |||
| 2 | Importing |
PORTAL_EVENT_NAMESPACE | Call by reference | Type reference (TYPE) | STRING | 20040429 | |||
| 3 | Importing |
VIEW | Call by reference | Object reference (TYPE REF TO) | IF_WD_VIEW_CONTROLLER | API eines Views | 20040413 |
Method UNSUBSCRIBE_EVENT on class IF_WD_PORTAL_INTEGRATION has no exception.
History
| Last changed by/on | SAP | 20130531 |
| SAP Release Created in |
