SAP ABAP Class CL_GRFN_CONTAINER_UIBB_ASSIST (Assistance Class for GRPC_BASE_OIF)

Hierarchy

☛ GRCFND_A (Software Component) GRC Foundation ABAP
   ⤷ GRC (Application Component) Governance, Risk and Compliance
     ⤷ GRFN_WD_REUSE (Package) GRC Common Layer Reusable UI Components

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_WD_COMPONENT_ASSISTANCE	Basis for a Web Dynpro assistance class	20100818
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_GRFN_FLD_CO	Field Group Constants	20100818
3	Interface implementation (CLASS c. INTERFACES i_ref)	IF_GRFN_UI_METADATA_CO	UI metadata constants	20100818

Properties

Class	CL_GRFN_CONTAINER_UIBB_ASSIST
Short Description	Assistance Class for GRPC_BASE_OIF
Super Class	CL_WD_COMPONENT_ASSISTANCE	Basis for a Web Dynpro assistance class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	GRFN_WD_REUSE	GRC Common Layer Reusable UI Components
Created	20100818	SAP
Last change	20141106
Shared Memory-enabled	☐
Fixed point arithmetic	☐
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	GRPC0	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
2	IF_GRFN_UI_METADATA_CO	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_GRFN_FLD_CO	☐	☐	Field Group Constants	20100818
2	IF_GRFN_UI_METADATA_CO	☐	☐	UI metadata constants	20100818

Friends

Class CL_GRFN_CONTAINER_UIBB_ASSIST has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_PLUG_TYPE	Constant	Public	☐	See coding				20100818
2	PLUG_HEADER	Constant	Public	☐	Type reference (TYPE)	GRPC_OIF_WD_TYPE	GC_PLUG_TYPE-HEADER	Header	20100818
3	PLUG_INVALID	Constant	Public	☐	Type reference (TYPE)	GRPC_OIF_WD_TYPE	GC_PLUG_TYPE-INVALID	Invalid	20100818
4	PLUG_INVISIBLE	Constant	Public	☐	Type reference (TYPE)	GRPC_OIF_WD_TYPE	GC_PLUG_TYPE-INVISIBLE	Invisible	20100818
5	PLUG_TAB	Constant	Public	☐	Type reference (TYPE)	GRPC_OIF_WD_TYPE	GC_PLUG_TYPE-TAB	Tab	20100818
6	TABSTRIP	Constant	Public	☐	Type reference (TYPE)	STRING	'TABSTRIP'		20100818

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	BUILD_UI_TAB_ID	Static method	Public	Method	Build IDs for UI Tab	20100818
2	BUILD_UI_UIBB_ID	Static method	Public	Method	Build IDs for UI UIBB	20100818
3	CONVERT_UI_MODE_FN2PC	Static method	Public	Method	Helper method, for converting UI mode	20100818
4	CONVERT_UI_MODE_PC2FN	Static method	Public	Method	Helper method, for converting UI mode	20100818
5	CREATE_PARAMETER_BY_WDEVENT	Static method	Public	Method	Create parameter by wdevent	20100818
6	GET_DEFAULT_PLUG_INFO	Static method	Public	Method	Get UIBB default plug information	20100818
7	GET_NAVI_PARAMETERS	Static method	Public	Method	Get dynamic navigation parameters	20100818
8	GET_OIF_CLASSNAME	Static method	Public	Method	Get OIF status management class name	20100818
9	GET_OIF_CONFIG	Static method	Public	Method	Get OIF configuration	20100818
10	GET_OIF_TABS	Static method	Public	Method	Get OIF configuration	20100818
11	GET_USAGE_TYPE	Static method	Public	Method	Get a variant's usage type	20100818

Events

Class CL_GRFN_CONTAINER_UIBB_ASSIST has no event.

Types

Class CL_GRFN_CONTAINER_UIBB_ASSIST has no local type.

Method Signatures

Method BUILD_UI_TAB_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_CAPTION_ID	Call by reference	☐	Type reference (TYPE)	STRING			20100818
2	Exporting	EV_CONT_ID	Call by reference	☐	Type reference (TYPE)	STRING			20100818
3	Exporting	EV_TAB_ID	Call by reference	☐	Type reference (TYPE)	STRING			20100818
4	Importing	IV_TAB	Call by reference	☐	Type reference (TYPE)	GRFN_TAB		Tab ID	20100818
5	Importing	IV_VARIANT	Call by reference	☐	Type reference (TYPE)	GRFN_UI_VARIANT			20100818

Method BUILD_UI_TAB_ID on class CL_GRFN_CONTAINER_UIBB_ASSIST has no exception.

Method BUILD_UI_UIBB_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_CONT_ID	Call by reference	☐	Type reference (TYPE)	STRING			20100818
2	Exporting	EV_EMBEDDING_POSITION	Call by reference	☐	Type reference (TYPE)	STRING			20100818
3	Importing	IV_PLUG_TYPE	Call by reference	☐	Type reference (TYPE)	GRPC_OIF_WD_TYPE		OIF plugin type: Header or Tab	20100818
4	Importing	IV_TAB	Call by reference	☐	Type reference (TYPE)	GRFN_TAB		Tab ID	20100818
5	Importing	IV_UIBB	Call by reference	☐	Type reference (TYPE)	GRFN_UIBB		UIBB ID	20100818
6	Importing	IV_VARIANT	Call by reference	☐	Type reference (TYPE)	GRFN_UI_VARIANT			20100818

Method BUILD_UI_UIBB_ID on class CL_GRFN_CONTAINER_UIBB_ASSIST has no exception.

Method CONVERT_UI_MODE_FN2PC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_MODE	Call by reference	☐	Type reference (TYPE)	GRFN_UI_MODE		Mode of OIF window	20100818
2	Returning	RV_MODE	Value transfer	☐	Type reference (TYPE)	STRING			20100818

Method CONVERT_UI_MODE_FN2PC on class CL_GRFN_CONTAINER_UIBB_ASSIST has no exception.

Method CONVERT_UI_MODE_PC2FN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_MODE	Call by reference	☐	Type reference (TYPE)	STRING			20100818
2	Returning	RV_MODE	Value transfer	☐	Type reference (TYPE)	GRFN_UI_MODE		Mode of OIF window	20100818

Method CONVERT_UI_MODE_PC2FN on class CL_GRFN_CONTAINER_UIBB_ASSIST has no exception.

Method CREATE_PARAMETER_BY_WDEVENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_EVENT	Call by reference	☐	Object reference (TYPE REF TO)	CL_WD_CUSTOM_EVENT		Application-Defined Event	20100818
2	Returning	RO_PARAMETER	Value transfer	☐	Object reference (TYPE REF TO)	CL_GRFN_UI_PARAMETER		UI Paramters, copied from CL_FPM_PARAMETER	20100818

Method CREATE_PARAMETER_BY_WDEVENT on class CL_GRFN_CONTAINER_UIBB_ASSIST has no exception.

Method GET_DEFAULT_PLUG_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EO_OIF	Call by reference	☐	Object reference (TYPE REF TO)	CL_GRPC_OIF_BASIS		OIF Instance	20100818
2	Exporting	EV_TAB	Call by reference	☐	Type reference (TYPE)	GRFN_TAB		Tab ID	20100818
3	Exporting	EV_UIBB	Call by reference	☐	Type reference (TYPE)	GRFN_UIBB		UIBB ID	20100818
4	Importing	IO_EVENT	Call by reference	☐	Object reference (TYPE REF TO)	CL_WD_CUSTOM_EVENT		Application-Defined Event	20100818

Method GET_DEFAULT_PLUG_INFO on class CL_GRFN_CONTAINER_UIBB_ASSIST has no exception.

Method GET_NAVI_PARAMETERS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_SOURCE_PLUG_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20100818
2	Exporting	EV_SOURCE_VUSAGE_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20100818
3	Exporting	EV_SOURCE_WINDOW_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20100818
4	Importing	IV_TAB	Call by reference	☐	Type reference (TYPE)	GRFN_TAB			20100818
5	Importing	IV_UIBB	Call by reference	☐	Type reference (TYPE)	GRFN_UIBB			20100818
6	Importing	IV_VARIANT	Call by reference	☐	Type reference (TYPE)	GRFN_UI_VARIANT		BASE OIF usage type	20100818

Method GET_NAVI_PARAMETERS on class CL_GRFN_CONTAINER_UIBB_ASSIST has no exception.

Method GET_OIF_CLASSNAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ENTITY_ID	Call by reference	☐	Type reference (TYPE)	GRFN_API_ENTITY_ID		Entity ID	20100818
2	Importing	IV_VARIANT	Call by reference	☐	Type reference (TYPE)	GRFN_UI_VARIANT	IF_GRFN_UI_METADATA_CO=>GC_UI_VARIANT-OIF	UI Variant	20100818
3	Returning	RV_CLASSNAME	Value transfer	☐	Type reference (TYPE)	STRING			20100818

Method GET_OIF_CLASSNAME on class CL_GRFN_CONTAINER_UIBB_ASSIST has no exception.

Method GET_OIF_CONFIG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_SESSION	Call by reference	☑	Object reference (TYPE REF TO)	CL_GRFN_API_SESSION		Session Management for GRC APIs	20100818
2	Importing	IV_APP	Value transfer	☑	Type reference (TYPE)	GRFN_APP_COMPONENT		Application Component	20100818
3	Importing	IV_ENTITY_ID	Value transfer	☐	Type reference (TYPE)	GRFN_API_ENTITY_ID		Entity ID	20100818
4	Importing	IV_REGULATION_ID	Value transfer	☑	Type reference (TYPE)	GRFN_API_OBJECT_ID		Object ID	20100818
5	Returning	RT_CONFIG	Value transfer	☐	Type reference (TYPE)	GRPC_T_OIF_CONF		OIF configuration table	20100818

Method GET_OIF_CONFIG on class CL_GRFN_CONTAINER_UIBB_ASSIST has no exception.

Method GET_OIF_TABS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_SESSION	Call by reference	☑	Object reference (TYPE REF TO)	CL_GRFN_API_SESSION		Session Management for GRC APIs	20100818
2	Importing	IV_APP	Value transfer	☑	Type reference (TYPE)	GRFN_APP_COMPONENT		Application Component	20100818
3	Importing	IV_ENTITY_ID	Value transfer	☐	Type reference (TYPE)	GRFN_API_ENTITY_ID		Entity ID	20100818
4	Importing	IV_REGULATION_ID	Value transfer	☑	Type reference (TYPE)	GRFN_API_OBJECT_ID		Object ID	20100818
5	Returning	RT_TABS	Value transfer	☐	Type reference (TYPE)	GRPC_T_OIF_TAB		OIF configuration table	20100818

Method GET_OIF_TABS on class CL_GRFN_CONTAINER_UIBB_ASSIST has no exception.

Method GET_USAGE_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_VARIANT	Call by reference	☐	Type reference (TYPE)	GRFN_UI_VARIANT		UI Variant	20100818
2	Returning	RV_USAGE_TYPE	Value transfer	☐	Type reference (TYPE)	GRFN_UI_USAGE_TYPE		Usage Type	20100818

Method GET_USAGE_TYPE on class CL_GRFN_CONTAINER_UIBB_ASSIST has no exception.

History

Last changed by/on	SAP	20141106
SAP Release Created in	V1000