SAP ABAP Class /UI2/CL_NWBC_CFG (NWBC Configuration API)
Hierarchy
☛
SAP_UI (Software Component) User Interface Technology
⤷
CA-UI2-INT-BE (Application Component) Backend Enablement
⤷
/UI2/NWBC_CFG (Package) NetWeaver Business Client - Configuration
⤷
⤷
Properties
| Class | /UI2/CL_NWBC_CFG | |
| Short Description | NWBC Configuration API | |
| Super Class | ||
| Instantiability of a Class | 0 | Private |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | /UI2/NWBC_CFG | NetWeaver Business Client - Configuration |
| Created | 20121025 | SAP |
| Last change | 20141120 | |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
Class /UI2/CL_NWBC_CFG has no interface implemented.
Friends
| # | Friend | Modeled only | Created on | Description |
|---|---|---|---|---|
| 1 | /UI2/IF_NWBC_CFG_FRIENDS | 20130322 | Used for friends relationship |
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Static Attribute | Private | See coding | Values of authority-check | 20121121 | ||||
| 2 | Constant | Private | Type reference (TYPE) | NUMC2 | '02' | Activity of an authorization check | 20140227 | ||
| 3 | Constant | Private | Type reference (TYPE) | NUMC2 | '03' | Activity of an authorization check | 20140227 | ||
| 4 | Constant | Public | Type reference (TYPE) | STRING | 'CUSTOMER' | Indicates That Parameter Belongs to Customer Configuration | 20130717 | ||
| 5 | Constant | Public | Type reference (TYPE) | STRING | 'SAP' | Indicates That Parameter Belongs to SAP Configuration | 20130717 | ||
| 6 | Constant | Public | Type reference (TYPE) | STRING | '*' | Wildcard Character of Path Filter in External Data Format | 20130315 | ||
| 7 | Constant | Public | Type reference (TYPE) | STRING | '+' | Wildcard Character of Path Filter in Internal Data Format | 20130315 | ||
| 8 | Constant | Private | Type reference (TYPE) | STRING | '/UI2/NWBC_CFG_NC' | Configuration Table of Customer Param Names + their Metadata | 20130423 | ||
| 9 | Constant | Private | Type reference (TYPE) | STRING | '/UI2/NWBC_CFGNCT' | Configuration Text Table of Customer Param Names | 20130506 | ||
| 10 | Constant | Private | Type reference (TYPE) | STRING | '/UI2/NWBC_CFGC' | Configuration Table of Customer Values | 20121102 | ||
| 11 | Constant | Private | Type reference (TYPE) | STRING | '/UI2/NWBC_CFGCT' | Configuration Table of Translated Customer Values | 20121102 | ||
| 12 | Constant | Private | Type reference (TYPE) | STRING | '/UI2/NWBC_CFG_N' | Configuration Table of SAP Param Names + their Metadata | 20130423 | ||
| 13 | Constant | Private | Type reference (TYPE) | STRING | '/UI2/NWBC_CFG_NT' | Configuration Text Table of SAP Param Names | 20130506 | ||
| 14 | Constant | Private | Type reference (TYPE) | STRING | '/UI2/NWBC_CFG' | Configuration Table of SAP Values | 20121102 | ||
| 15 | Constant | Private | Type reference (TYPE) | STRING | '/UI2/NWBC_CFGT' | Configuration Table of Translated SAP Values | 20121102 | ||
| 16 | Instance attribute | Private | Object reference (TYPE REF TO) | IF_HTTP_SERVER | HTTP Framework (iHTTP) HTTP Server | 20130315 | |||
| 17 | Instance attribute | Private | Type reference (TYPE) | T_PARAM_BUFFER_TAB | Parameter Buffer | 20121102 | |||
| 18 | Static Attribute | Private | Object reference (TYPE REF TO) | /UI2/CL_NWBC_CFG | NWBC Configuration API | 20121025 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Private | Method | Adjust parameter value programmatically | 20130315 | |
| 2 | Instance method | Public | Constructor | CONSTRUCTOR | 20121121 | |
| 3 | Instance method | Protected | Method | Delete specific entry | 20121121 | |
| 4 | Instance method | Private | Method | Delete parameter from the buffer | 20121121 | |
| 5 | Instance method | Private | Method | Check authorization | 20121121 | |
| 6 | Static method | Public | Method | Get instance of this class | 20121025 | |
| 7 | Instance method | Public | Method | Get specific entry | 20121025 | |
| 8 | Instance method | Public | Method | Get all entries | 20121025 | |
| 9 | Instance method | Private | Method | Get Parameter Definitions | 20130423 | |
| 10 | Instance method | Private | Method | Get value of reserved parameter | 20121025 | |
| 11 | Instance method | Protected | Method | Set specific entry | 20121025 | |
| 12 | Instance method | Private | Method | Set parameter into the buffer | 20121102 |
Events
Class /UI2/CL_NWBC_CFG has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | T_PARAM_BUFFER | Public | See coding | 20121102 | BEGIN OF t_param_buffer,
path_filter TYPE /ui2/nwbc_cfg_path_filter,
parameter_name TYPE /ui2/nwbc_cfg_param_name,
is_translatable TYPE /ui2/nwbc_cfg_param_translate,
is_reserved TYPE /ui2/nwbc_cfg_param_reserved,
parameter_value TYPE /ui2/nwbc_cfg_param_value_s,
scope TYPE c LENGTH 8, " 'SAP' or 'CUSTOMER', see constants
END OF t_param_buffer
|
||
| 2 | T_PARAM_BUFFER_TAB | Public | See coding | 20121130 | t_param_buffer_tab TYPE STANDARD TABLE OF t_param_buffer WITH KEY path_filter parameter_name
|
||
| 3 | T_PARAM_DEF | Public | See coding | 20130423 | BEGIN OF t_param_def.
include type /ui2/nwbc_cfg_n.
TYPES:
language TYPE langu,
description TYPE /ui2/nwbc_cfg_param_descr,
END OF t_param_def
|
||
| 4 | T_PARAM_DEF_TAB | Public | See coding | 20130423 | t_param_def_tab TYPE STANDARD TABLE OF t_param_def WITH KEY parameter_name
|
Method Signatures
Method ADJUST_PARAM Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | C_PARAM | Call by reference | Type reference (TYPE) | T_PARAM_BUFFER | 20130315 |
Method ADJUST_PARAM on class /UI2/CL_NWBC_CFG has no exception.
Method CONSTRUCTOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IO_HTTP_SERVER | Call by reference | Object reference (TYPE REF TO) | IF_HTTP_SERVER | HTTP Framework (iHTTP) HTTP Server | 20130315 |
Method CONSTRUCTOR on class /UI2/CL_NWBC_CFG has no exception.
Method DEL_PARAM Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_PARAM | Call by reference | Type reference (TYPE) | T_PARAM_BUFFER | 20121121 |
Method DEL_PARAM on class /UI2/CL_NWBC_CFG has no exception.
Method DEL_PARAM_BUFFER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_PARAM | Call by reference | Type reference (TYPE) | T_PARAM_BUFFER | NWBC Configuration Table: Parameter Names | 20121121 |
Method DEL_PARAM_BUFFER on class /UI2/CL_NWBC_CFG has no exception.
Method GET_AUTHORITY_CHECK Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_ACTIVITY | Call by reference | Type reference (TYPE) | CLIKE | 20140227 |
Method GET_AUTHORITY_CHECK on class /UI2/CL_NWBC_CFG has no exception.
Method GET_INSTANCE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IO_HTTP_SERVER | Call by reference | Object reference (TYPE REF TO) | IF_HTTP_SERVER | HTTP Framework (iHTTP) HTTP Server | 20130315 | |||
| 2 | R_RESULT | Value transfer | Object reference (TYPE REF TO) | /UI2/CL_NWBC_CFG | NWBC Configuration API | 20121025 |
Method GET_INSTANCE on class /UI2/CL_NWBC_CFG has no exception.
Method GET_PARAM Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_PARAMETER_NAME | Call by reference | Type reference (TYPE) | CSEQUENCE | NWBC Configuration Table: Parameter Name | 20121025 | |||
| 2 | I_PATH_FILTER | Call by reference | Type reference (TYPE) | CSEQUENCE | NWBC Configuration Table: Path Filter | 20121025 | |||
| 3 | R_PARAMETER_VALUE | Value transfer | Type reference (TYPE) | /UI2/NWBC_CFG_PARAM_VALUE_S | NWBC Configuration Table: Parameter Value | 20121025 |
Method GET_PARAM on class /UI2/CL_NWBC_CFG has no exception.
Method GET_PARAMS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_PATH_FILTER | Call by reference | Type reference (TYPE) | CSEQUENCE | NWBC Configuration Table: Path Filter | 20121130 | |||
| 2 | R_PARAMS | Value transfer | Type reference (TYPE) | T_PARAM_BUFFER_TAB | 20121130 |
Method GET_PARAMS on class /UI2/CL_NWBC_CFG has no exception.
Method GET_PARAM_DEFINITIONS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_PARAMETER_NAME | Call by reference | Type reference (TYPE) | CSEQUENCE | NWBC Configuration Table: Parameter Name | 20130423 | |||
| 2 | I_PROVIDE_DESCRIPTION | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Provide Parameter Description | 20130506 | ||
| 3 | R_PARAM_DEFINITIONS | Value transfer | Type reference (TYPE) | T_PARAM_DEF_TAB | 20130423 |
Method GET_PARAM_DEFINITIONS on class /UI2/CL_NWBC_CFG has no exception.
Method GET_PARAM_RESERVED Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_PARAMETER_NAME | Call by reference | Type reference (TYPE) | /UI2/NWBC_CFG_PARAM_NAME | NWBC Configuration Table: Parameter Name | 20121025 | |||
| 2 | I_PATH_FILTER | Call by reference | Type reference (TYPE) | /UI2/NWBC_CFG_PATH_FILTER | NWBC Configuration Table: Path Filter | 20121102 | |||
| 3 | R_PARAMS | Value transfer | Type reference (TYPE) | T_PARAM_BUFFER_TAB | 20121203 |
Method GET_PARAM_RESERVED on class /UI2/CL_NWBC_CFG has no exception.
Method SET_PARAM Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_PARAM | Call by reference | Type reference (TYPE) | T_PARAM_BUFFER | 20121102 |
Method SET_PARAM on class /UI2/CL_NWBC_CFG has no exception.
Method SET_PARAM_BUFFER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | I_PARAM | Call by reference | Type reference (TYPE) | T_PARAM_BUFFER | NWBC Configuration Table: Parameter Names | 20121102 |
Method SET_PARAM_BUFFER on class /UI2/CL_NWBC_CFG has no exception.
History
| Last changed by/on | SAP | 20141120 |
| SAP Release Created in | 100 |