SAP ABAP Class CL_NWBC_RUNTIME (Business Client Runtime v3.0)

Hierarchy

☛ SAP_UI (Software Component) User Interface Technology
   ⤷ BC-FES-BUS (Application Component) Netweaver Business Client
     ⤷ SAP_NWBC (Package) NetWeaver Business Client

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_NWBC_RUNTIME	The NWBC Runtime Interface	20061010
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_NWBC_RUNTIME_CORE	The NWBC Runtime Interface (Core Functionality)	20091001

Properties

Class	CL_NWBC_RUNTIME
Short Description	Business Client Runtime v3.0
Super Class
Instantiability of a Class	0	Private
Final	☑

General Data

Message Class
Program status
Category	0
Package	SAP_NWBC	NetWeaver Business Client
Created	20061009	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	CL_NWBC	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
3	IF_NWBC_RUNTIME	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_NWBC_RUNTIME	☐	☐	The NWBC Runtime Interface	20061010
2	IF_NWBC_RUNTIME_CORE	☐	☐	The NWBC Runtime Interface (Core Functionality)	20091001

Friends

Class CL_NWBC_RUNTIME has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	BASE_URL	Instance attribute	Private	☐	Attribute reference (LIKE)				20101208
2	CACHED_COCKPITS	Instance attribute	Private	☐	Type reference (TYPE)	IF_NWBC_RUNTIME~T_COCKPITS			20061012
3	CACHED_COCKPITS_WITH_ROLES	Instance attribute	Private	☐	Type reference (TYPE)	IF_NWBC_RUNTIME~T_COCKPITS_WITH_ROLES			20090322
4	CACHED_CONFIGURATION	Instance attribute	Private	☐	Type reference (TYPE)	IF_NWBC_RUNTIME~T_CONFIGURATION			20090320
5	CACHED_NAVIGATION_TREE	Instance attribute	Private	☐	Type reference (TYPE)	IF_NWBC_RUNTIME~T_NAVIGATION_TREE			20070226
6	CACHED_OBN_TARGETS	Instance attribute	Private	☐	Type reference (TYPE)	IF_NWBC_RUNTIME~T_OBN_TARGETS			20061012
7	CACHED_ROLES	Instance attribute	Private	☐	Type reference (TYPE)	IF_NWBC_RUNTIME~T_ROLES			20061012
8	CACHED_RUNTIME	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CL_NWBC_RUNTIME			20101208
9	CACHED_SYSTEM_INFO	Instance attribute	Private	☐	Type reference (TYPE)	IF_NWBC_RUNTIME~T_SYSTEM_INFO			20090306
10	CACHED_TROUBLE_SHOOTING_INFO	Instance attribute	Private	☐	Type reference (TYPE)	IF_NWBC_RUNTIME~T_TROUBLE_SHOOTING_INFO			20090301
11	CACHED_USER_INFO	Instance attribute	Private	☐	Type reference (TYPE)	IF_NWBC_RUNTIME~T_USER_INFO			20090310
12	COCKPIT	Instance attribute	Private	☐	Attribute reference (LIKE)				20101208
13	COCKPIT_UPPERCASE	Instance attribute	Private	☐	Attribute reference (LIKE)				20101208
14	CONFIG	Instance attribute	Private	☐	Type reference (TYPE)	IF_NWBC_RUNTIME~T_NWBC_CFG_DB_TABLE		NetWeaver Business Client	20070227
15	FULL_QUALIFIED_BASE_URL	Instance attribute	Private	☐	Attribute reference (LIKE)				20101208
16	FULL_QUALIFIED_HOST	Instance attribute	Private	☐	Attribute reference (LIKE)				20101208
17	ICF_BASE_URL	Instance attribute	Private	☐	Attribute reference (LIKE)				20101208
18	NWBC_SHELL	Instance attribute	Private	☐	Attribute reference (LIKE)				20101208
19	ROLE_FILTER	Instance attribute	Private	☐	Attribute reference (LIKE)				20101208
20	RUNTIME_LOAD	Instance attribute	Private	☐	Attribute reference (LIKE)				20101208
21	SAP_RELEASE_702_PLUS	Instance attribute	Private	☐	Attribute reference (LIKE)				20101208
22	SERVER	Instance attribute	Private	☐	Attribute reference (LIKE)				20101208
23	URL	Instance attribute	Private	☐	Attribute reference (LIKE)				20101208
24	VERSION	Instance attribute	Private	☐	Attribute reference (LIKE)				20101208

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONSTRUCTOR	Instance method	Private	Constructor	CONSTRUCTOR	20061010
2	DECODE_UNIQUE_ID	Instance method	Private	Method	Encodes navigation tree unique id	20110211
3	ENCODE_UNIQUE_ID	Instance method	Private	Method	Encodes navigation tree unique id	20110211
4	GET	Static method	Public	Method	Return NWBC Runtime	20061009
5	GET_NODES	Instance method	Private	Method		20101208
6	GET_ROLES_TEXTS	Instance method	Protected	Method	Get Texts of PFCG Roles	20130314
7	GET_USER_INFO	Instance method	Private	Method		20101208
8	READ_BIT	Static method	Private	Method	Reads bit value	20111117
9	RESOLVE_NAVIGATION	Instance method	Private	Method		20101208
10	RESOLVE_OBN	Instance method	Private	Method	resolve object.method	20100927
11	TREE_SERIALIZE_CONTEXT	Instance method	Private	Method	Create NWBC context for navigation entry	20110211

Events

Class CL_NWBC_RUNTIME has no event.

Types

Class CL_NWBC_RUNTIME has no local type.

Method Signatures

Method CONSTRUCTOR 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			20090319
2	Importing	COCKPIT	Call by reference	☑	Type reference (TYPE)	STRING			20061010
3	Importing	FULL_QUALIFIED_BASE_URL	Call by reference	☑	Type reference (TYPE)	STRING			20090323
4	Importing	ICF_BASE_URL	Call by reference	☑	Type reference (TYPE)	STRING		Internal ICF path	20090529
5	Importing	NWBC_SHELL	Call by reference	☐	Type reference (TYPE)	STRING	''	cl_nwbc=>for_desktop | cl_nwbc=>for_html	20091204
6	Importing	ROLE_FILTER	Call by reference	☑	Type reference (TYPE)	STRING			20090703
7	Importing	SERVER	Call by reference	☑	Object reference (TYPE REF TO)	IF_HTTP_SERVER		HTTP Framework (iHTTP) HTTP Server	20090227

Method CONSTRUCTOR on class CL_NWBC_RUNTIME has no exception.

Method DECODE_UNIQUE_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	AGR_NAME	Call by reference	☐	Type reference (TYPE)	AGR_NAME		Role Name	20110211
2	Exporting	MENU_TYPE	Call by reference	☐	Type reference (TYPE)	IF_NWBC_RUNTIME=>T_MENU_TYPE		Menu type	20110211
3	Exporting	ORIGIN_ID	Call by reference	☐	Type reference (TYPE)	STRING		Original id of node from PFCG	20110211
4	Exporting	SYSID	Call by reference	☐	Attribute reference (LIKE)	SY-SYSID		Name of the SAP System	20110211
5	Importing	UNIQUE_ID	Call by reference	☐	Type reference (TYPE)	STRING		Node Unique ID	20110211

Method DECODE_UNIQUE_ID on class CL_NWBC_RUNTIME has no exception.

Method ENCODE_UNIQUE_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	AGR_NAME	Call by reference	☐	Type reference (TYPE)	AGR_NAME		Role Name	20110211
2	Importing	MENU_TYPE	Call by reference	☑	Type reference (TYPE)	IF_NWBC_RUNTIME=>T_MENU_TYPE		Menu Type	20110211
3	Importing	ORIGIN_ID	Call by reference	☐	Type reference (TYPE)	STRING		Original id of node from PFCG	20110211
4	Importing	SYSID	Call by reference	☐	Attribute reference (LIKE)	SY-SYSID	SY-SYSID	Name of the SAP System	20110211
5	Returning	UNIQUE_ID	Value transfer	☐	Type reference (TYPE)	STRING		Node Unique ID	20110211

Method ENCODE_UNIQUE_ID on class CL_NWBC_RUNTIME has no exception.

Method GET 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)	CSEQUENCE	``		20090319
2	Importing	COCKPIT	Call by reference	☐	Type reference (TYPE)	CSEQUENCE	``		20061009
3	Importing	FULL_QUALIFIED_BASE_URL	Call by reference	☐	Type reference (TYPE)	CSEQUENCE	``		20090323
4	Importing	ICF_BASE_URL	Call by reference	☐	Type reference (TYPE)	CSEQUENCE	``		20090529
5	Importing	NWBC_SHELL	Call by reference	☐	Type reference (TYPE)	CSEQUENCE	``	cl_nwbc=>for_desktop | cl_nwbc=>for_html	20091204
6	Importing	ROLE_FILTER	Call by reference	☐	Type reference (TYPE)	CSEQUENCE	``		20090703
7	Returning	RUNTIME	Value transfer	☐	Object reference (TYPE REF TO)	IF_NWBC_RUNTIME			20061009
8	Importing	SERVER	Call by reference	☑	Object reference (TYPE REF TO)	IF_HTTP_SERVER		HTTP Framework (iHTTP) HTTP Server	20090224

Method GET on class CL_NWBC_RUNTIME has no exception.

Method GET_NODES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_ROLE_IDS	Call by reference	☐	Type reference (TYPE)	IF_NWBC_RUNTIME=>T_ROLE_IDS			20101208
2	Exporting	ET_NODES	Call by reference	☐	Type reference (TYPE)	IF_NWBC_RUNTIME=>T_NODES			20101208
3	Exporting	ET_TEXTS	Call by reference	☐	Type reference (TYPE)	IF_NWBC_RUNTIME=>T_TEXTS			20101208
4	Exporting	ET_URLS	Call by reference	☐	Type reference (TYPE)	IF_NWBC_RUNTIME=>T_URLS			20101208
5	Exporting	EV_SAP_MENUS_ACTIVE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20101208
6	Importing	IV_ALL_LANGUAGES	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20101208
7	Importing	IV_LANGU	Call by reference	☐	Type reference (TYPE)	SYLANGU	SY-LANGU	Language Key of Current Text Environment	20101208
8	Importing	IV_USER	Call by reference	☐	Type reference (TYPE)	CSEQUENCE			20101208

Method GET_NODES on class CL_NWBC_RUNTIME has no exception.

Method GET_ROLES_TEXTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_DESCRIPTIONS	Call by reference	☐	Type reference (TYPE)	IF_NWBC_RUNTIME=>T_ROLES_LANG_TEXTS		Language Specific Descriptions of Roles	20130314
2	Exporting	ET_TEXTS	Call by reference	☐	Type reference (TYPE)	IF_NWBC_RUNTIME=>T_ROLES_LANG_TEXTS		Language Specific Short Texts of Roles	20130314
3	Importing	IT_ROLES_IDS	Call by reference	☐	Type reference (TYPE)	IF_NWBC_RUNTIME=>T_ROLE_IDS		Names of PFCG Roles	20130314
4	Importing	IV_LANGU	Call by reference	☑	Type reference (TYPE)	SYLANGU		Default: sy-langu with fallback to master langu of role	20130314

Method GET_ROLES_TEXTS on class CL_NWBC_RUNTIME has no exception.

Method GET_USER_INFO Signature

Method GET_USER_INFO on class CL_NWBC_RUNTIME has no parameter.
Method GET_USER_INFO on class CL_NWBC_RUNTIME has no exception.

Method READ_BIT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FLAGS	Call by reference	☐	Type reference (TYPE)	CHAR4			20111117
2	Importing	MASK	Call by reference	☐	Type reference (TYPE)	XUBITVEC16			20111117
3	Returning	RV_RESULT	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20111117

Method READ_BIT on class CL_NWBC_RUNTIME has no exception.

Method RESOLVE_NAVIGATION Signature

Method RESOLVE_NAVIGATION on class CL_NWBC_RUNTIME has no parameter.
Method RESOLVE_NAVIGATION on class CL_NWBC_RUNTIME has no exception.

Method RESOLVE_OBN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_OBN_TARGET	Call by reference	☐	Type reference (TYPE)	IF_NWBC_RUNTIME~T_OBN_TARGET			20100927
2	Importing	METHOD	Call by reference	☐	Type reference (TYPE)	STRING			20100927
3	Importing	NAVIGATION_TREE	Call by reference	☐	Type reference (TYPE)	IF_NWBC_RUNTIME~T_NAVIGATION_TREE			20100927
4	Importing	OBJECT	Call by reference	☐	Type reference (TYPE)	STRING			20100927
5	Importing	OBN_TARGETS	Call by reference	☐	Type reference (TYPE)	IF_NWBC_RUNTIME~T_OBN_TARGETS			20100927
6	Importing	REQUEST_OBN_RESOLVE_LOG	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20100927

Method RESOLVE_OBN on class CL_NWBC_RUNTIME has no exception.

Method TREE_SERIALIZE_CONTEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	NAVIGATION_ENTRY	Call by reference	☐	Type reference (TYPE)	IF_NWBC_RUNTIME=>T_NAVIGATION_ENTRY		Navigation entry	20110211
2	Returning	RV_CONTEXT	Value transfer	☐	Type reference (TYPE)	STRING		URL encoded context string	20110211

Method TREE_SERIALIZE_CONTEXT on class CL_NWBC_RUNTIME has no exception.

History

Last changed by/on	SAP	20130531
SAP Release Created in	711