SAP ABAP Class /UI2/CL_CHIP_GADGET_DESCR_HELP (Helper class for gadget CHIPs)

Hierarchy

☛ SAP_UI (Software Component) User Interface Technology
   ⤷ CA-UI2-INT-BE (Application Component) Backend Enablement
     ⤷ /UI2/SERVICES_PB_UTIL_700 (Package) Utilities Pagebuilding Service

Properties

Class	/UI2/CL_CHIP_GADGET_DESCR_HELP
Short Description	Helper class for gadget CHIPs
Super Class
Instantiability of a Class	0	Private
Final	☑

General Data

Message Class
Program status
Category	0
Package	/UI2/SERVICES_PB_UTIL_700	Utilities Pagebuilding Service
Created	20111013	SAP
Last change	20141120
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class /UI2/CL_CHIP_GADGET_DESCR_HELP has no forward declaration.

Interfaces

Class /UI2/CL_CHIP_GADGET_DESCR_HELP has no interface implemented.

Friends

Class /UI2/CL_CHIP_GADGET_DESCR_HELP has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CO_WD_COMPONENT_CONFIG	Constant	Public	☐	Type reference (TYPE)	WDY_COMPONENT_NAME	'/UI2/CHIP_GADGET_CONFIG'		20111013
2	CO_WD_COMPONENT_UI	Static Attribute	Public	☐	Type reference (TYPE)	WDY_COMPONENT_NAME	'/UI2/CHIP_GADGET'		20111013
3	MT_CONFIGS	Static Attribute	Private	☐	Type reference (TYPE)	TY_CONFIGS			20111013
4	MT_CUSTOM_PARAMETERS	Instance attribute	Private	☐	Type reference (TYPE)	/UI2/CHIP_DEFINITION_PARAMS			20111013
5	MT_DESCRIPTIONS	Instance attribute	Private	☐	Type reference (TYPE)	/UI2/CHIP_DESCRIPTIONS_LANGU			20111013
6	MT_DISPLAY_NAMES	Instance attribute	Private	☐	Type reference (TYPE)	/UI2/CHIP_DISPLAY_NAMES_LANGU			20111013
7	M_CHIP_NAME	Instance attribute	Private	☐	Type reference (TYPE)	/UI2/CHIP_NAME			20111013
8	M_CONFIG_ID	Instance attribute	Private	☐	Type reference (TYPE)	WDY_CONFIG_ID			20111013

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONSTRUCTOR	Instance method	Private	Constructor		20111013
2	CREATE_FROM_CONFIG_ID	Static method	Public	Method		20111013
3	GET_CHIP_DEFINITION	Instance method	Public	Method		20111013
4	GET_CHIP_DESCRIPTION	Instance method	Private	Method		20111013
5	GET_INTERNAL_INFOS	Instance method	Private	Method		20111013
6	GET_METADATA_FROM_XML	Instance method	Private	Method	Read parameters from CHIP xml	20120308
7	RAISE_EXCEPTION_READ_XML	Static method	Private	Method	Raise exception for method read_xml	20131118
8	READ_CHIP_XML	Static method	Public	Method	Given the path read the CHIP xml file	20131216
9	READ_CHIP_XML_HTTP	Static method	Private	Method	Given the path read the CHIP xml file	20131216
10	READ_CHIP_XML_INT	Static method	Private	Method	Given the path read the CHIP xml file	20131216
11	READ_CHIP_XML_MIME	Static method	Private	Method	Read chip xml out of MIME repository	20131216
12	READ_CHIP_XML_UI5	Static method	Private	Method	Read chip xml out of UI5 repository	20131216

Events

Class /UI2/CL_CHIP_GADGET_DESCR_HELP has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_CONFIG	Private	See coding			20111013	begin of ty_config, config_id type string, config_proxy type ref to /ui2/cl_chip_gadget_descr_help, end of ty_config
2	TY_CONFIGS	Private	See coding			20111013	ty_configs type hashed table of ty_config with unique key config_id

Method Signatures

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CONFIG_ID	Call by reference	☐	Type reference (TYPE)	STRING			20111013

#	Exception	Resumable	Description	Created on
1	CX_WD_CONFIGURATION	☐		20111013

Method CREATE_FROM_CONFIG_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CONFIG_ID	Call by reference	☐	Type reference (TYPE)	STRING			20111013
2	Returning	CONFIG_PROXY	Value transfer	☐	Object reference (TYPE REF TO)	/UI2/CL_CHIP_GADGET_DESCR_HELP			20111013

#	Exception	Resumable	Description	Created on
1	CX_WD_CONFIGURATION	☐		20111013

Method GET_CHIP_DEFINITION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	CHIP_DEFINITION	Value transfer	☐	Object reference (TYPE REF TO)	/UI2/IF_CHIP_DEFINITION			20111013

#	Exception	Resumable	Description	Created on
1	/UI2/CX_CHIP_CATALOG	☐		20120820

Method GET_CHIP_DESCRIPTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	CHIP_DESCRIPTION	Value transfer	☐	Object reference (TYPE REF TO)	/UI2/IF_CHIP_DESCRIPTION			20111013

#	Exception	Resumable	Description	Created on
1	/UI2/CX_CHIP_CATALOG	☐		20130326

Method GET_INTERNAL_INFOS Signature

Method GET_INTERNAL_INFOS on class /UI2/CL_CHIP_GADGET_DESCR_HELP has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_WD_CONFIGURATION	☐		20111013

Method GET_METADATA_FROM_XML Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_CHIP_PARAMETERS	Call by reference	☐	Type reference (TYPE)	/UI2/CHIP_DEFINITION_PARAMS		CHIP Definition: Table of Parameters	20120308
2	Importing	IV_GADGET_PATH	Call by reference	☐	Type reference (TYPE)	STRING			20120308

#	Exception	Resumable	Description	Created on
1	/UI2/CX_CHIP_CATALOG	☐	Exceptions in UI2 CHIP catalog	20120820

Method RAISE_EXCEPTION_READ_XML Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_HTTP_CLIENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_HTTP_CLIENT		HTTP Client Abstraction	20131118
2	Importing	IV_CHIP_NAME	Call by reference	☐	Type reference (TYPE)	/UI2/CHIP_NAME		Web Dynpro ABAP: CHIP ID	20131118
3	Importing	IV_PATH	Call by reference	☐	Type reference (TYPE)	STRING		Path name	20131118
4	Importing	IV_REASON	Call by reference	☑	Type reference (TYPE)	STRING		Reason	20131118
5	Importing	IV_STATUS	Call by reference	☑	Type reference (TYPE)	I		Status number	20131118
6	Importing	IV_SUBRC	Call by reference	☐	Type reference (TYPE)	SYSUBRC		Return Value of ABAP Statements	20131118
7	Importing	IV_TEXTID	Call by reference	☐	Type reference (TYPE)	SOTR_CONC		Text ID	20131118

#	Exception	Resumable	Description	Created on
1	/UI2/CX_CHIP_CATALOG	☐	Exceptions in UI2 CHIP catalog	20131118

Method READ_CHIP_XML Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CHIP_NAME	Call by reference	☐	Type reference (TYPE)	/UI2/CHIP_NAME_PROVIDER		Web Dynpro ABAP: CHIP ID	20131216
2	Importing	IV_PATH	Call by reference	☐	Type reference (TYPE)	STRING			20131216
3	Returning	RV_XML	Value transfer	☐	Type reference (TYPE)	STRING			20131216

#	Exception	Resumable	Description	Created on
1	/UI2/CX_CHIP_CATALOG	☐	Exceptions in UI2 CHIP catalog	20131216

Method READ_CHIP_XML_HTTP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CHIP_NAME	Call by reference	☐	Type reference (TYPE)	/UI2/CHIP_NAME_PROVIDER		Web Dynpro ABAP: CHIP ID	20131216
2	Importing	IV_PATH	Call by reference	☐	Type reference (TYPE)	STRING			20131216
3	Returning	RV_XML	Value transfer	☐	Type reference (TYPE)	STRING			20131216

#	Exception	Resumable	Description	Created on
1	/UI2/CX_CHIP_CATALOG	☐	Exceptions in UI2 CHIP catalog	20131216

Method READ_CHIP_XML_INT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CHIP_NAME	Call by reference	☐	Type reference (TYPE)	/UI2/CHIP_NAME_PROVIDER		Web Dynpro ABAP: CHIP ID	20131216
2	Importing	IV_PATH	Call by reference	☐	Type reference (TYPE)	STRING			20131216
3	Importing	IV_TEST_MODE	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL		To be used with unit tests only	20131216
4	Returning	RV_XML	Value transfer	☐	Type reference (TYPE)	STRING			20131216

#	Exception	Resumable	Description	Created on
1	/UI2/CX_CHIP_CATALOG	☐	Exceptions in UI2 CHIP catalog	20131216

Method READ_CHIP_XML_MIME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CHIP_NAME	Call by reference	☐	Type reference (TYPE)	/UI2/CHIP_NAME_PROVIDER		CHIP: Provider-Specific CHIP Name	20131216
2	Importing	IV_PATH	Call by reference	☐	Type reference (TYPE)	STRING			20131216
3	Returning	RV_XML	Value transfer	☐	Type reference (TYPE)	STRING			20131216

#	Exception	Resumable	Description	Created on
1	/UI2/CX_CHIP_CATALOG	☐	Exceptions in UI2 CHIP catalog	20131216

Method READ_CHIP_XML_UI5 Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CHIP_NAME	Call by reference	☐	Type reference (TYPE)	/UI2/CHIP_NAME_PROVIDER		CHIP: Provider-Specific CHIP Name	20131216
2	Importing	IV_PATH	Call by reference	☐	Type reference (TYPE)	STRING			20131216
3	Returning	RV_XML	Value transfer	☐	Type reference (TYPE)	STRING			20131216

#	Exception	Resumable	Description	Created on
1	/UI2/CX_CHIP_CATALOG	☐	Exceptions in UI2 CHIP catalog	20131216

History

Last changed by/on	SAP	20141120
SAP Release Created in	200