SAP ABAP Class /UI2/CL_NWBC (External Functionality for NWBC)
Hierarchy
☛
SAP_UI (Software Component) User Interface Technology
⤷
CA-UI2-INT-BE (Application Component) Backend Enablement
⤷
/UI2/NWBC_CORE (Package) NetWeaver Business Client - Core Functionality
SAP_UI (Software Component) User Interface Technology⤷
CA-UI2-INT-BE (Application Component) Backend Enablement⤷
/UI2/NWBC_CORE (Package) NetWeaver Business Client - Core FunctionalityProperties
| Class | /UI2/CL_NWBC | |
| Short Description | External Functionality for NWBC | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | /UI2/NWBC_CORE | NetWeaver Business Client - Core Functionality |
| Created | 20120821 | SAP |
| Last change | 20141120 | |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 |  /UI2/CL_NWBC |
Forward declaration class (CLASS c DEFINITION DEFERRED) | Forward declaration class (CLASS c DEFINITION DEFERRED) |
| 2 | /UI2/CL_NWBC_SERVER_ASSIST |
Forward declaration class (CLASS c DEFINITION DEFERRED) | Forward declaration class (CLASS c DEFINITION DEFERRED) |
| 3 | /UI2/CL_URL |
Forward declaration class (CLASS c DEFINITION DEFERRED) | Forward declaration class (CLASS c DEFINITION DEFERRED) |
| 4 | ABAP |
Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
| 5 | CL_NWBC |
Forward declaration class (CLASS c DEFINITION DEFERRED) | Forward declaration class (CLASS c DEFINITION DEFERRED) |
| 6 | CL_URL |
Forward declaration class (CLASS c DEFINITION DEFERRED) | Forward declaration class (CLASS c DEFINITION DEFERRED) |
Interfaces
Class /UI2/CL_NWBC has no interface implemented.
Friends
| # | Friend | Modeled only | Created on | Description |
|---|---|---|---|---|
| 1 | /UI2/CL_NWBC_HTTP | 20120828 | NW Business Client HTTP Handler |
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ALIAS |
Constant | Public | Type reference (TYPE) | STRING | '/ui2/nwbc' | 20120903 | ||
| 2 | CANVAS__WINDOW__APP |
Constant | Public | Type reference (TYPE) | STRING | 'app' | 20120821 | ||
| 3 | CANVAS__WINDOW__EMBEDDED |
Constant | Public | Type reference (TYPE) | STRING | 'embedded' | 20120821 | ||
| 4 | CANVAS__WINDOW__MAIN |
Constant | Public | Type reference (TYPE) | STRING | 'main' | 20120821 | ||
| 5 | CONTEXT_HTTP_FORM_FIELD |
Constant | Public | Type reference (TYPE) | STRING | 'sap-nwbc-context' | 20120821 | ||
| 6 | FOR_API |
Constant | Public | Type reference (TYPE) | STRING | 'API access to PFCG' | 20140324 | ||
| 7 | FOR_DESKTOP |
Constant | Public | Type reference (TYPE) | STRING | 'NWBC for Desktop' | 20120821 | ||
| 8 | FOR_HTML |
Constant | Public | Type reference (TYPE) | STRING | 'NWBC for HTML' | 20120821 | ||
| 9 | ICF_NODE |
Constant | Public | Type reference (TYPE) | STRING | '/sap/bc/ui2/nwbc' | 20120903 | ||
| 10 | SCOPE_CANVAS |
Constant | Public | Type reference (TYPE) | STRING | '' | 20120821 | ||
| 11 | SCOPE_LINKCOLLECTION |
Constant | Public | Type reference (TYPE) | STRING | 'L' | 20120821 | ||
| 12 | SCOPE_SIDEPANEL |
Constant | Public | Type reference (TYPE) | STRING | 'S' | 20120821 | ||
| 13 | SESSION_CONTEXT |
Static Attribute | Private | Type reference (TYPE) | /UI2/CL_NWBC=>T_CONTEXT | 20120821 | |||
| 14 | STARTUP_SEQUENCE_APP_ALIAS |
Constant | Public | Type reference (TYPE) | STRING | 'applicationAlias' | 20120821 | ||
| 15 | STARTUP_SEQUENCE_OBN |
Constant | Public | Type reference (TYPE) | STRING | 'obn' | 20120821 | ||
| 16 | STARTUP_SEQUENCE_ROLE_ENTRY |
Constant | Public | Type reference (TYPE) | STRING | 'roleEntry' | 20120821 | ||
| 17 | STARTUP_SEQUENCE_SITEMAP |
Constant | Public | Type reference (TYPE) | STRING | 'sitemap' | 20120821 | ||
| 18 | STARTUP_SEQUENCE_TRANSACTION |
Constant | Public | Type reference (TYPE) | STRING | 'transaction' | 20120821 | ||
| 19 | STARTUP_SEQUENCE_URL |
Constant | Public | Type reference (TYPE) | STRING | 'url' | 20120821 | ||
| 20 | STARTUP_SEQUENCE_WDA |
Constant | Public | Type reference (TYPE) | STRING | 'wda' | 20120821 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | ADD_QUERY_PARAMETER |
Static method | Public | Method | Adds, if not exist already, parameter to URL | 20130923 |
| 2 | APPEND_SLASH |
Static method | Public | Method | Append slash to the end of path is not yet there | 20120821 |
| 3 | CLASS_CONSTRUCTOR |
Static method | Public | Constructor | 20120821 | |
| 4 | CONTEXT_GET |
Static method | Public | Method | Return the current context for this session | 20120821 |
| 5 | CONTEXT_SERIALIZE |
Static method | Public | Method | Given a context, construct string for sap-nwbc-context | 20120821 |
| 6 | CONTEXT_SERIALIZE_DEFAULT |
Static method | Public | Method | Given a context, construct string for sap-nwbc-context | 20130419 |
| 7 | CONTEXT_SET |
Static method | Public | Method | Return the current context for this session | 20120821 |
| 8 | CONTEXT_SET_FROM_HTTP_REQUEST |
Static method | Public | Method | Setup context from URL parameter sap-nwbc-context | 20120821 |
| 9 | CONTEXT_URL_ADD |
Static method | Public | Method | Given a context, construct string for sap-nwbc-context | 20120821 |
| 10 | CONTEXT_URL_UPDATE |
Static method | Public | Method | Given a context, construct string for sap-nwbc-context | 20120821 |
| 11 | GET_RUNTIME_IVERSION |
Static method | Public | Method | 20120821 | |
| 12 | GET_RUNTIME_VERSION |
Static method | Public | Method | 20120821 | |
| 13 | INITIALIZE_CLIENT |
Static method | Public | Method | Called to initialize client features | 20120821 |
| 14 | IS_ACTIVE |
Static method | Public | Method | Is NWBC active (check for valid context) | 20130617 |
| 15 | MIGRATE_CONTEXT |
Static method | Protected | Method | Migrate runtime SAP_BASIS context to UI2 NWBC context | 20130704 |
| 16 | OBN_PARAM_BUILD_CLUSTER_ID |
Static method | Private | Method | build cluster id | 20120821 |
| 17 | OBN_PARAM_CLEAN_UP_DB |
Static method | Private | Method | clean up obn param buffer | 20120821 |
| 18 | OBN_PARAM_GET |
Static method | Public | Method | OBSOLETE | 20120821 |
| 19 | OBN_PARAM_SET |
Static method | Public | Method | OBSOLETE | 20120821 |
| 20 | READ_QUERY_PARAMETER |
Static method | Public | Method | Replace parameter in URL | 20120821 |
| 21 | REPLACE_QUERY_PARAMETER |
Static method | Public | Method | Replace parameter in URL | 20120821 |
| 22 | SE93_LAUNCH |
Static method | Public | Method | Launch NWBC in a browser | 20120821 |
| 23 | SPLIT_TAGS |
Static method | Public | Method | Splits string based on regular expression | 20120821 |
| 24 | URL_BASE |
Static method | Public | Method | Return a base URL to a NWBC handler | 20120821 |
| 25 | URL_CONSTRUCT |
Static method | Public | Method | Contruct NWBC URL onto a shell (optional canvas) | 20120821 |
| 26 | URL_LAUNCH |
Static method | Public | Method | Launch NWBC in a browser | 20120821 |
| 27 | URL_TYPE_LAUNCHABLE |
Static method | Public | Method | Determine what type of URL can be launched | 20120821 |
Events
Class /UI2/CL_NWBC has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | T_CLUSTER_ID | Private | See coding | 20120821 | t_cluster_id(44) TYPE c
|
||
| 2 | T_CONTEXT | Public | See coding | 20120821 | BEGIN OF t_context,
valid TYPE abap_bool, " set to abap_true if context has been set for this session
runtime_version TYPE string, " runtime version
support_bits TYPE string, " feature bits string of the client
client_version TYPE string, " version of connected client
role_name TYPE string, " name of role as in PFCG
role_id TYPE string, " object_id of the node relative to the role
role_filter TYPE string, " active role filter
cockpit TYPE string, " active cockpit
sysid TYPE sy-sysid, " NWBC sysid
mandt TYPE sy-mandt, " NWBC client
scope TYPE string, " reference /ui2/cl_nwbc=>scope_*
canvas_window TYPE string, " reference /ui2/cl_nwbc=>canvas__window__*
nwbc_shell TYPE string, " reference /ui2/cl_nwbc=>nwbc_for_*
default_context TYPE string, " serialized default user context
END OF t_context
|
||
| 3 | T_DECORATION | Public | See coding | 20130521 | BEGIN OF t_decoration,
style TYPE string,
no_branding TYPE boole_d,
END OF t_decoration
|
||
| 4 | T_OBN_PARAM_UNIQUE_KEY | Public | See coding | 20120821 | t_obn_param_unique_key TYPE c LENGTH 32
|
||
| 5 | T_STRINGS | Public | See coding | 20120821 | t_strings TYPE STANDARD TABLE OF string
|
Method Signatures
Method ADD_QUERY_PARAMETER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
PARAM_NAME | Call by reference | Type reference (TYPE) | CSEQUENCE | Name of paramater to update | 20130923 | ||
| 2 | Importing |
PARAM_VALUE | Call by reference | Type reference (TYPE) | CSEQUENCE | New paramater value | 20130923 | ||
| 3 |  Changing |
POST_BODY | Call by reference | Type reference (TYPE) | TIHTTPNVP | HTTP Framework (iHTTP) Table Name/Value Pairs | 20130923 | ||
| 4 | Changing |
URL | Call by reference | Type reference (TYPE) | STRING | Post body to update | 20130923 |
Method ADD_QUERY_PARAMETER on class /UI2/CL_NWBC has no exception.
Method APPEND_SLASH Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_URL | Call by reference | Type reference (TYPE) | CSEQUENCE | 20120821 | |||
| 2 |  Returning |
RV_URL | Value transfer | Type reference (TYPE) | STRING | 20120821 |
Method APPEND_SLASH on class /UI2/CL_NWBC has no exception.
Method CLASS_CONSTRUCTOR Signature
Method CLASS_CONSTRUCTOR on class /UI2/CL_NWBC has no parameter.
Method CLASS_CONSTRUCTOR on class /UI2/CL_NWBC has no exception.
Method CONTEXT_GET Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
CONTEXT | Value transfer | Type reference (TYPE) | /UI2/CL_NWBC=>T_CONTEXT | 20120821 | |||
| 2 | Importing |
CONTEXT_STRING | Call by reference | Type reference (TYPE) | STRING | If given, the return this context, otherwise global context | 20120821 | ||
| 3 | Importing |
HTTP_REQUEST | Call by reference | Object reference (TYPE REF TO) | IF_HTTP_REQUEST | HTTP Framework (iHTTP) HTTP Request | 20120821 |
Method CONTEXT_GET on class /UI2/CL_NWBC has no exception.
Method CONTEXT_SERIALIZE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
CANVAS_WINDOW | Call by reference | Type reference (TYPE) | STRING | /UI2/CL_NWBC=>CANVAS__WINDOW__MAIN | 20120821 | ||
| 2 | Importing |
CONTEXT | Call by reference | Type reference (TYPE) | /UI2/CL_NWBC=>T_CONTEXT | 20120821 | |||
| 3 | Returning |
CONTEXT_STRING | Value transfer | Type reference (TYPE) | STRING | 20120821 | |||
| 4 | Importing |
NWBC_SHELL | Call by reference | Type reference (TYPE) | STRING | /UI2/CL_NWBC=>FOR_DESKTOP | 20120821 | ||
| 5 | Importing |
ROLE_ID | Call by reference | Type reference (TYPE) | CSEQUENCE | 20120821 | |||
| 6 | Importing |
ROLE_NAME | Call by reference | Type reference (TYPE) | CSEQUENCE | 20120821 | |||
| 7 | Importing |
RUNTIME | Call by reference | Object reference (TYPE REF TO) | /UI2/IF_NWBC_RUNTIME | The NWBC Runtime Interface | 20120821 | ||
| 8 | Importing |
SCOPE | Call by reference | Type reference (TYPE) | STRING | /UI2/CL_NWBC=>SCOPE_CANVAS | Current NWBC scope | 20120821 |
Method CONTEXT_SERIALIZE on class /UI2/CL_NWBC has no exception.
Method CONTEXT_SERIALIZE_DEFAULT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
CONTEXT_STRING | Value transfer | Type reference (TYPE) | STRING | 20130419 | |||
| 2 | Importing |
RUNTIME | Call by reference | Object reference (TYPE REF TO) | /UI2/IF_NWBC_RUNTIME | The NWBC Runtime Interface | 20130419 |
Method CONTEXT_SERIALIZE_DEFAULT on class /UI2/CL_NWBC has no exception.
Method CONTEXT_SET Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IR_HTTP_REQUEST | Call by reference | Object reference (TYPE REF TO) | IF_HTTP_REQUEST | HTTP Framework (iHTTP) HTTP Request | 20120821 | ||
| 2 | Importing |
IS_CONTEXT | Call by reference | Type reference (TYPE) | /UI2/CL_NWBC=>T_CONTEXT | 20120821 | |||
| 3 | Importing |
IV_CONTEXT_STRING | Call by reference | Type reference (TYPE) | STRING | If given, the return this context, otherwise global context | 20120821 | ||
| 4 | Returning |
RS_CONTEXT | Value transfer | Type reference (TYPE) | /UI2/CL_NWBC=>T_CONTEXT | 20120821 |
Method CONTEXT_SET on class /UI2/CL_NWBC has no exception.
Method CONTEXT_SET_FROM_HTTP_REQUEST Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
CONTEXT_STRING | Call by reference | Type reference (TYPE) | CSEQUENCE | The string from URL parameter sap-nwbc-context | 20120821 |
Method CONTEXT_SET_FROM_HTTP_REQUEST on class /UI2/CL_NWBC has no exception.
Method CONTEXT_URL_ADD Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Changing |
CT_POST_BODY | Call by reference | Type reference (TYPE) | TIHTTPNVP | HTTP Framework (iHTTP) Table Name/Value Pairs | 20120821 | ||
| 2 | Changing |
CV_URL | Call by reference | Type reference (TYPE) | STRING | 20120821 | |||
| 3 | Importing |
IV_CONTEXT | Call by reference | Type reference (TYPE) | T_CONTEXT | 20120821 | |||
| 4 | Importing |
IV_CONTEXT_STRING | Call by reference | Type reference (TYPE) | CSEQUENCE | 20120821 | |||
| 5 | Importing |
IV_FORCE_REPLACE | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | 20120821 |
Method CONTEXT_URL_ADD on class /UI2/CL_NWBC has no exception.
Method CONTEXT_URL_UPDATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
CANVAS_WINDOW | Call by reference | Type reference (TYPE) | CSEQUENCE | 20120821 | |||
| 2 | Importing |
NWBC_SHELL | Call by reference | Type reference (TYPE) | CSEQUENCE | 20120821 | |||
| 3 | Changing |
POST_BODY | Call by reference | Type reference (TYPE) | TIHTTPNVP | HTTP Framework (iHTTP) Table Name/Value Pairs | 20120821 | ||
| 4 | Importing |
ROLE_ID | Call by reference | Type reference (TYPE) | CSEQUENCE | 20120821 | |||
| 5 | Importing |
ROLE_NAME | Call by reference | Type reference (TYPE) | CSEQUENCE | 20120821 | |||
| 6 | Changing |
URL | Call by reference | Type reference (TYPE) | STRING | 20120821 |
Method CONTEXT_URL_UPDATE on class /UI2/CL_NWBC has no exception.
Method GET_RUNTIME_IVERSION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
IVERSION | Value transfer | Type reference (TYPE) | I | 20120821 | |||
| 2 | Importing |
VERSION | Call by reference | Type reference (TYPE) | STRING | 20120821 |
Method GET_RUNTIME_IVERSION on class /UI2/CL_NWBC has no exception.
Method GET_RUNTIME_VERSION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
VERSION | Value transfer | Type reference (TYPE) | STRING | 20120821 |
Method GET_RUNTIME_VERSION on class /UI2/CL_NWBC has no exception.
Method INITIALIZE_CLIENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
EV_ALREADY_INITIALIZED | Call by reference | Type reference (TYPE) | ABAP_BOOL | 20130418 | |||
| 2 | Importing |
NWBC_SHELL | Call by reference | Type reference (TYPE) | STRING | /UI2/CL_NWBC=>FOR_HTML | 20130418 | ||
| 3 | Importing |
SB_NWBC_NATIVE_SAPGUI | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | 20130418 | ||
| 4 | Importing |
SB_NWBC_NAVIGATE | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Client supports NWBC-Navigate | 20120821 | |
| 5 | Importing |
SB_NWBC_OBN | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Client supports NWBC-OBN | 20120821 | |
| 6 | Importing |
SB_NWBC_TAB_BROWSING | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Client supports Tab Browsing | 20120821 | |
| 7 | Importing |
SUPPORT_BITS | Call by reference | Type reference (TYPE) | STRING | Client feature bits | 20120821 | ||
| 8 | Importing |
VERSION | Call by reference | Type reference (TYPE) | STRING | Client version | 20120821 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  ALREADY_INITIALIZED |
20120824 |
Method IS_ACTIVE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RV_VALUE | Value transfer | Type reference (TYPE) | ABAP_BOOL | 20130617 |
Method IS_ACTIVE on class /UI2/CL_NWBC has no exception.
Method MIGRATE_CONTEXT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RV_CONTEXT | Value transfer | Type reference (TYPE) | T_CONTEXT | Converted SAP_BASIS context | 20130704 |
Method MIGRATE_CONTEXT on class /UI2/CL_NWBC has no exception.
Method OBN_PARAM_BUILD_CLUSTER_ID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_UNAME | Call by reference | Attribute reference (LIKE) | SY-UNAME | User Name | 20120821 | ||
| 2 | Importing |
IV_UNIQUE_KEY | Call by reference | Type reference (TYPE) | /UI2/CL_NWBC=>T_OBN_PARAM_UNIQUE_KEY | Unique Key to store a OBN Parameter Value to a shared cache | 20120821 | ||
| 3 | Returning |
RV_CLUSTER_ID | Value transfer | Type reference (TYPE) | T_CLUSTER_ID | 20120821 |
Method OBN_PARAM_BUILD_CLUSTER_ID on class /UI2/CL_NWBC has no exception.
Method OBN_PARAM_CLEAN_UP_DB Signature
Method OBN_PARAM_CLEAN_UP_DB on class /UI2/CL_NWBC has no parameter.
Method OBN_PARAM_CLEAN_UP_DB on class /UI2/CL_NWBC has no exception.
Method OBN_PARAM_GET Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_DATA | Value transfer | Type reference (TYPE) | DATA | 20120821 | |||
| 2 | Importing |
IV_UNIQUE_KEY | Call by reference | Type reference (TYPE) | /UI2/CL_NWBC=>T_OBN_PARAM_UNIQUE_KEY | 20120821 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | /UI2/CX_NWBC_STATIC_CHECK |
20120824 |
Method OBN_PARAM_SET Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IT_DATA | Call by reference | Type reference (TYPE) | DATA | 20120821 | |||
| 2 | Importing |
IV_UNIQUE_KEY | Call by reference | Type reference (TYPE) | T_OBN_PARAM_UNIQUE_KEY | 20120821 | |||
| 3 | Returning |
RV_UNIQUE_KEY | Value transfer | Type reference (TYPE) | T_OBN_PARAM_UNIQUE_KEY | 20120821 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | /UI2/CX_NWBC_STATIC_CHECK |
20120824 |
Method READ_QUERY_PARAMETER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Changing |
CT_POST | Call by reference | Type reference (TYPE) | TIHTTPNVP | Post body to update | 20120821 | ||
| 2 | Changing |
CV_GET | Call by reference | Type reference (TYPE) | STRING | Get paramaters to update | 20120821 | ||
| 3 | Changing |
CV_URL | Call by reference | Type reference (TYPE) | STRING | URL to update | 20120821 | ||
| 4 | Exporting |
EV_SUBRC | Call by reference | Type reference (TYPE) | SYSUBRC | 0 if parameter has been found | 20130117 | ||
| 5 | Importing |
IV_DELETE | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Controls if parameter should be deleted | 20120821 | |
| 6 | Importing |
IV_NAME | Call by reference | Type reference (TYPE) | CSEQUENCE | Name of paramater to update | 20120821 | ||
| 7 | Changing |
RV_VALUE | Call by reference | Type reference (TYPE) | STRING | Paramater value | 20120821 |
Method READ_QUERY_PARAMETER on class /UI2/CL_NWBC has no exception.
Method REPLACE_QUERY_PARAMETER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
PARAM_DEFAULT | Call by reference | Type reference (TYPE) | CSEQUENCE | Url to update | 20130418 | ||
| 2 | Importing |
PARAM_NAME | Call by reference | Type reference (TYPE) | CSEQUENCE | Name of paramater to update | 20120821 | ||
| 3 | Importing |
PARAM_VALUE | Call by reference | Type reference (TYPE) | CSEQUENCE | New paramater value | 20120821 | ||
| 4 | Changing |
POST_BODY | Call by reference | Type reference (TYPE) | TIHTTPNVP | HTTP Framework (iHTTP) Table Name/Value Pairs | 20120821 | ||
| 5 | Changing |
URL | Call by reference | Type reference (TYPE) | STRING | Post body to update | 20120821 |
Method REPLACE_QUERY_PARAMETER on class /UI2/CL_NWBC has no exception.
Method SE93_LAUNCH Signature
Method SE93_LAUNCH on class /UI2/CL_NWBC has no parameter.
Method SE93_LAUNCH on class /UI2/CL_NWBC has no exception.
Method SPLIT_TAGS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
REGEXP | Call by reference | Type reference (TYPE) | STRING | Pattern | 20120821 | ||
| 2 | Exporting |
RESULTS | Call by reference | Type reference (TYPE) | T_STRINGS | Transfer of Strings at Runtime | 20120821 | ||
| 3 | Importing |
STRING | Call by reference | Type reference (TYPE) | STRING | Value to parse | 20120821 | ||
| 4 | Importing |
SUB_REGEXP | Call by reference | Type reference (TYPE) | STRING | Optional sub Pattern | 20120821 |
Method SPLIT_TAGS on class /UI2/CL_NWBC has no exception.
Method URL_BASE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
APPLICATION | Call by reference | Type reference (TYPE) | CSEQUENCE | /UI2/CL_URL=>MC_APPLICATION | Default httpurlloc applicaiton name | 20120821 | |
| 2 | Exporting |
CLIENT | Call by reference | Attribute reference (LIKE) | SY-MANDT | Client | 20130925 | ||
| 3 | Importing |
COCKPIT | Call by reference | Type reference (TYPE) | CSEQUENCE | 20120821 | |||
| 4 | Importing |
DOMAIN | Call by reference | Type reference (TYPE) | CSEQUENCE | Default httpurlloc domain name | 20120821 | ||
| 5 | Importing |
PATH | Call by reference | Type reference (TYPE) | CSEQUENCE | Alternative path/alias to NWBC handler to use | 20120821 | ||
| 6 | Importing |
PREFER_SERVER_RELATIVE_URL | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Do not add server part, if possible | 20130925 | |
| 7 | Importing |
SERVER | Call by reference | Object reference (TYPE REF TO) | IF_HTTP_SERVER | Use for determining proxies in network | 20120821 | ||
| 8 | Importing |
SM59_ALIAS | Call by reference | Type reference (TYPE) | CSEQUENCE | Destination for which URL should be generated | 20120821 | ||
| 9 | Exporting |
URL | Call by reference | Type reference (TYPE) | STRING | Server absolute URL | 20120821 |
Method URL_BASE on class /UI2/CL_NWBC has no exception.
Method URL_CONSTRUCT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
APPLICATION | Call by reference | Type reference (TYPE) | CSEQUENCE | /UI2/CL_URL=>MC_APPLICATION | Default httpurlloc applicaiton name | 20120821 | |
| 2 | Importing |
CANVAS_APPLICATION_ALIAS | Call by reference | Type reference (TYPE) | CSEQUENCE | Canvas = applicationAlias | 20120821 | ||
| 3 | Importing |
CANVAS_OBN | Call by reference | Type reference (TYPE) | CSEQUENCE | Canvas = OBN: object.method | 20120821 | ||
| 4 | Importing |
CANVAS_ROLE_ENTRY | Call by reference | Type reference (TYPE) | CSEQUENCE | Canvas = RoleEntry: role:object_id | 20120821 | ||
| 5 | Importing |
CANVAS_SITEMAP | Call by reference | Type reference (TYPE) | ABAP_BOOL | Canvas = sitemap | 20120821 | ||
| 6 | Importing |
CANVAS_TRANSACTION | Call by reference | Type reference (TYPE) | CSEQUENCE | Transaction code to start | 20120821 | ||
| 7 | Importing |
CANVAS_TRANSACTION__CLNT_TYPE | Call by reference | Type reference (TYPE) | STRING | 'auto' | auto | sapgui | webgui | 20120821 | |
| 8 | Importing |
CANVAS_URL | Call by reference | Type reference (TYPE) | CSEQUENCE | Canvas = URL: must be server absolute URL! (start with "/") | 20120821 | ||
| 9 | Importing |
CANVAS_WDA | Call by reference | Type reference (TYPE) | CSEQUENCE | Canvas = WDA: Web Dynpro ABAP ( [/namespace/]name) | 20120821 | ||
| 10 | Importing |
CANVAS_WDA__CLIENT_TYPE | Call by reference | Type reference (TYPE) | STRING | 'auto' | auto | html | nwbc (smart client) | 20120821 | |
| 11 | Importing |
CANVAS__WINDOW | Call by reference | Type reference (TYPE) | STRING | CANVAS__WINDOW__MAIN | main (Main Window) | app (Application Window) | 20120821 | |
| 12 | Importing |
COCKPIT | Call by reference | Type reference (TYPE) | CSEQUENCE | Optional cockpit to activate | 20120821 | ||
| 13 | Importing |
DECORATION | Call by reference | Type reference (TYPE) | T_DECORATION | Decoration settings | 20120821 | ||
| 14 | Importing |
DOMAIN | Call by reference | Type reference (TYPE) | CSEQUENCE | Default httpurlloc domain name | 20120821 | ||
| 15 | Importing |
FOR_SESSION_USE | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | 20120821 | ||
| 16 | Importing |
FOR_USE_IN_EMAIL | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | 20120821 | ||
| 17 | Importing |
HTML_CLIENT | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | Use HTML Client ==> NWBC HTML | 20120821 | |
| 18 | Importing |
PATH | Call by reference | Type reference (TYPE) | CSEQUENCE | Alternative path/alias to NWBC handler to use | 20120821 | ||
| 19 | Importing |
PREFER_SERVER_RELATIVE_URL | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Do not add server part, if possible | 20130925 | |
| 20 | Importing |
QUERY_PARAMETERS | Call by reference | Type reference (TYPE) | TIHTTPNVP | Query parameters, appended onto query_string | 20120821 | ||
| 21 | Importing |
QUERY_STRING | Call by reference | Type reference (TYPE) | CSEQUENCE | Query string name=value format, already URL encoded | 20120821 | ||
| 22 | Importing |
RE_ENTRANCE_TICKET | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Only desktop client, add short lived re-entrace ticket | 20120821 | |
| 23 | Importing |
ROLE | Call by reference | Type reference (TYPE) | CSEQUENCE | Option role filter | 20120821 | ||
| 24 | Importing |
RUNTIME_LOAD | Call by reference | Type reference (TYPE) | CSEQUENCE | Alternative Z-Runtime | 20120821 | ||
| 25 | Importing |
SERVER | Call by reference | Object reference (TYPE REF TO) | IF_HTTP_SERVER | HTTP Framework (iHTTP) HTTP Server | 20120821 | ||
| 26 | Importing |
SM59_ALIAS | Call by reference | Type reference (TYPE) | CSEQUENCE | Destination for which URL should be generated | 20120821 | ||
| 27 | Returning |
URL | Value transfer | Type reference (TYPE) | STRING | Server absolute URL | 20120821 |
Method URL_CONSTRUCT on class /UI2/CL_NWBC has no exception.
Method URL_LAUNCH Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
URL | Call by reference | Type reference (TYPE) | CSEQUENCE | NWBC URL Constructed before | 20120821 |
Method URL_LAUNCH on class /UI2/CL_NWBC has no exception.
Method URL_TYPE_LAUNCHABLE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
DESKTOP_CLIENT | Call by reference | Type reference (TYPE) | ABAP_BOOL | Can we launch a desktop based NWBC? | 20120821 | ||
| 2 | Exporting |
HTML_CLIENT | Call by reference | Type reference (TYPE) | ABAP_BOOL | Can we launch a browser based NWBC? | 20120821 |
Method URL_TYPE_LAUNCHABLE on class /UI2/CL_NWBC has no exception.
History
| Last changed by/on | SAP | 20141120 |
| SAP Release Created in | 100 |
