SAP ABAP Class CL_EHSGWB_TOOLS (EHS: LWB Tools)

Hierarchy

☛ EA-APPL (Software Component) SAP Enterprise Extension PLM, SCM, Financials
   ⤷ EHS-SAF (Application Component) Product Safety
     ⤷ CBGLMP_WB (Package) EHS: Labeling Workbench Framework

Properties

Class	CL_EHSGWB_TOOLS
Short Description	EHS: LWB Tools
Super Class
Instantiability of a Class	1	Protected
Final	☑

General Data

Message Class
Program status
Category	0
Package	CBGLMP_WB	EHS: Labeling Workbench Framework
Created	20110914	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_EHSGBC_CONSTANTS	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
3	CL_EHSGWB_CONSTANTS	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
4	ESP1	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_EHSGWB_TOOLS has no interface implemented.

Friends

Class CL_EHSGWB_TOOLS has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GT_TOOL	Static Attribute	Private	☐	Type reference (TYPE)	TY_LT_TOOL		Tool Objects Depending on BP ID	20110914
2	MT_DATA_TYPES	Instance attribute	Private	☐	Type reference (TYPE)	TY_LT_DATA_TYPES			20110914
3	MV_BP_ID	Instance attribute	Private	☐	Type reference (TYPE)	CBGLE_WB_BP_ID		Business Process ID	20110914

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	AS_VALUES_EXTERNAL	Instance method	Public	Method	Convert Values from Internal to External Format	20110914
2	AS_VALUES_INTERNAL	Instance method	Public	Method	Convert Values from External to Internal Format	20110914
3	AS_VALUE_EXTERNAL	Instance method	Public	Method	Convert a Single Value from Internal to External Format	20110914
4	AS_VALUE_INTERNAL	Instance method	Public	Method	Convert a Single Value from External to Internal Format	20110914
5	CHECK_QUERY_HAS_NO_RESTRICT	Instance method	Public	Method	Check the Query Definition if There are No Restrictions	20110914
6	CONSTRUCTOR	Instance method	Public	Constructor		20110914
7	CONVERT_TABLE	Static method	Public	Method	Convert a Table into a New Table with a Defined Structure	20120319
8	CREATE_REF_NAME	Instance method	Private	Method	Create a Data Reference Name	20110914
9	CREATE_WHERE_COND_BY_QUERY	Instance method	Public	Method	Create a Dynamic WHERE Condition from Query Definition	20110914
10	GET_DATA_TYPES	Instance method	Private	Method	Determine Data Types of Given Query Criteria	20110914
11	GET_INSTANCE_CL	Static method	Public	Method	Get Tool Object of BP	20110914
12	GET_SHLP_DEFAULT_SELOPT	Instance method	Private	Method	Determine Data Types of Given Query Criteria	20120526
13	GET_SHLP_VALUES	Instance method	Public	Method	Determine Search Help Values	20110914
14	GET_SHLP_VALUES_BY_SHLP	Instance method	Private	Method	Determine Search Help Values Based on Specified Search Help	20110914
15	GET_SHLP_VALUES_BY_TAB_FIELD	Instance method	Private	Method	Determine Search Help Values Based on Table/Field Name	20110914
16	GET_STYPE_DESCRIPTION	Static method	Public	Method	Determines Description of Output Format of Sequence Number	20130108

Events

Class CL_EHSGWB_TOOLS has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_LS_DATA_TYPES	Private	See coding			20110914	BEGIN OF ty_ls_data_types, id TYPE CBGLE_WB_query_crit_ID, type TYPE dynptype, END OF ty_ls_data_types
2	TY_LS_TOOL	Private	See coding			20110914	BEGIN OF ty_ls_tool, bp_id TYPE CBGLE_WB_BP_ID, object TYPE REF TO CL_EHSGWB_TOOLS, END OF ty_ls_tool
3	TY_LT_DATA_TYPES	Private	See coding			20110914	ty_lt_data_types TYPE STANDARD TABLE OF ty_ls_data_types WITH KEY id
4	TY_LT_TOOL	Private	See coding			20110914	ty_lt_tool TYPE STANDARD TABLE OF ty_ls_tool WITH KEY bp_id

Method Signatures

Method AS_VALUES_EXTERNAL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ID	Call by reference	☐	Type reference (TYPE)	CBGLE_WB_QUERY_CRIT_ID			20110914
2	Changing	XT_VALUE_RANGE	Call by reference	☑	Type reference (TYPE)	CCGLD_WB_QUERY_CRIT_VR_TAB		EHS: LWB query criteria value range table	20110914
3	Changing	XV_VALUE	Call by reference	☑	Type reference (TYPE)	CBGLE_WB_QUERY_CRIT_VALUE		Query criteria value	20110914

Method AS_VALUES_EXTERNAL on class CL_EHSGWB_TOOLS has no exception.

Method AS_VALUES_INTERNAL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ID	Call by reference	☐	Type reference (TYPE)	CBGLE_WB_QUERY_CRIT_ID			20110914
2	Changing	XT_VALUE_RANGE	Call by reference	☑	Type reference (TYPE)	CCGLD_WB_QUERY_CRIT_VR_TAB		EHS: LWB query criteria value range table	20110914
3	Changing	XV_VALUE	Call by reference	☑	Type reference (TYPE)	CBGLE_WB_QUERY_CRIT_VALUE		Query criteria value	20110914

Method AS_VALUES_INTERNAL on class CL_EHSGWB_TOOLS has no exception.

Method AS_VALUE_EXTERNAL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_ABAP_COMPDESCR	Call by reference	☑	Type reference (TYPE)	ABAP_COMPDESCR			20110914
2	Importing	IV_ID	Call by reference	☑	Type reference (TYPE)	CBGLE_WB_QUERY_CRIT_ID			20110914
3	Changing	XV_VALUE	Call by reference	☐	Type reference (TYPE)	CBGLE_WB_ALV_COLUMN		ALV column	20110914

Method AS_VALUE_EXTERNAL on class CL_EHSGWB_TOOLS has no exception.

Method AS_VALUE_INTERNAL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_ABAP_COMPDESCR	Call by reference	☑	Type reference (TYPE)	ABAP_COMPDESCR			20110914
2	Importing	IV_ID	Call by reference	☑	Type reference (TYPE)	CBGLE_WB_QUERY_CRIT_ID			20110914
3	Changing	XV_VALUE	Call by reference	☐	Type reference (TYPE)	CBGLE_WB_QUERY_CRIT_VALUE		Query criteria value	20110914

Method AS_VALUE_INTERNAL on class CL_EHSGWB_TOOLS has no exception.

Method CHECK_QUERY_HAS_NO_RESTRICT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_QUERY_DEF	Call by reference	☐	Type reference (TYPE)	CCGLD_WB_QUERY_CRIT_VALUES		EHS: LWB query criteria values	20110914
2	Returning	RV_FLG_DO_NOT_EXECUTE	Value transfer	☐	Type reference (TYPE)	AS4FLAG		User aborted execution of a generic query	20110914

Method CHECK_QUERY_HAS_NO_RESTRICT on class CL_EHSGWB_TOOLS has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_BP_ID	Call by reference	☐	Type reference (TYPE)	CBGLE_WB_BP_ID		Business Process ID	20110914

Method CONSTRUCTOR on class CL_EHSGWB_TOOLS has no exception.

Method CONVERT_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_DATA	Call by reference	☐	Type reference (TYPE)	ANY TABLE		Konvertierte Tabelle	20120319
2	Importing	IT_DATA	Call by reference	☐	Type reference (TYPE)	ANY TABLE		Zu konvertierende Tabelle	20120319
3	Importing	IV_NEW_STRUCTURE_NAME	Call by reference	☐	Type reference (TYPE)	CBGLE_WB_STRUCTURE_NAME		Name der Struktur	20120319

Method CONVERT_TABLE on class CL_EHSGWB_TOOLS has no exception.

Method CREATE_REF_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_NUMBER	Call by reference	☐	Type reference (TYPE)	SYTABIX		Index of Internal Tables	20110914
2	Importing	IV_PREFIX	Call by reference	☐	Type reference (TYPE)	STRING	'		20110914
3	Returning	RV_REF_NAME	Value transfer	☐	Type reference (TYPE)	STRING			20110914

Method CREATE_REF_NAME on class CL_EHSGWB_TOOLS has no exception.

Method CREATE_WHERE_COND_BY_QUERY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_DATA_REF	Call by reference	☐	Type reference (TYPE)	CCGLD_WB_TABIX		EHS: LWB table of table indexes	20110914
2	Exporting	EV_WHERE_COND	Call by reference	☐	Type reference (TYPE)	STRING		Dynamic WHERE condition	20110914
3	Changing	XT_QUERY_DEF	Call by reference	☐	Type reference (TYPE)	CCGLD_WB_QUERY_CRIT_VALUES		EHS: LWB query criteria values	20110914

Method CREATE_WHERE_COND_BY_QUERY on class CL_EHSGWB_TOOLS has no exception.

Method GET_DATA_TYPES Signature

Method GET_DATA_TYPES on class CL_EHSGWB_TOOLS has no parameter.
Method GET_DATA_TYPES on class CL_EHSGWB_TOOLS has no exception.

Method GET_INSTANCE_CL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_BP_ID	Call by reference	☐	Type reference (TYPE)	CBGLE_WB_BP_ID		Business Process ID	20110914
2	Returning	RO_TOOL	Value transfer	☐	Object reference (TYPE REF TO)	CL_EHSGWB_TOOLS		EHS: LWB tools	20110914

#	Exception	Resumable	Description	Created on
1	CX_EHSGWB_EXCEPTION	☐		20110914

Method GET_SHLP_DEFAULT_SELOPT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_SHLP	Call by reference	☐	Type reference (TYPE)	SHLP_DESCR		Beschreibung einer Suchhilfe	20120526
2	Returning	RT_SELOPT	Value transfer	☐	Type reference (TYPE)	DDSHSELOPS		Selektionsoptionen für Suchhilfen	20120526

Method GET_SHLP_DEFAULT_SELOPT on class CL_EHSGWB_TOOLS has no exception.

Method GET_SHLP_VALUES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_ERRORS	Call by reference	☐	Type reference (TYPE)	BAL_T_MSG		Application Log: Table with Messages	20110914
2	Exporting	ET_VALUES	Call by reference	☐	Type reference (TYPE)	CCGLD_WB_DDSHRETVAL		EHS: Table of DDSHRETVAL	20110914
3	Importing	IV_FIELDNAME	Call by reference	☐	Type reference (TYPE)	CBGLE_WB_F4_FIELDNAME		Field name for value help	20110914
4	Importing	IV_FLG_SUPPRESS_RECORDLIST	Call by reference	☐	Type reference (TYPE)	AS4FLAG	ABAP_FALSE	'X': no popup with recordlist; ' ':popup with recordlist	20120228
5	Importing	IV_SHLPNAME	Call by reference	☑	Type reference (TYPE)	CBGLE_WB_F4_SEARCHHELPNAME		Name of a search help	20110914
6	Importing	IV_TABNAME	Call by reference	☑	Type reference (TYPE)	CBGLE_WB_F4_TABNAME		Name of table for value help	20110914
7	Importing	IV_VALUE	Call by reference	☐	Type reference (TYPE)	LVC_VALUE		ALV Control: Cell Content	20110914

Method GET_SHLP_VALUES on class CL_EHSGWB_TOOLS has no exception.

Method GET_SHLP_VALUES_BY_SHLP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_ERRORS	Call by reference	☐	Type reference (TYPE)	BAL_T_MSG		Application Log: Table with Messages	20110914
2	Exporting	ET_VALUES	Call by reference	☐	Type reference (TYPE)	CCGLD_WB_DDSHRETVAL		EHS: Table of DDSHRETVAL	20110914
3	Importing	IV_FIELDNAME	Call by reference	☐	Type reference (TYPE)	CBGLE_WB_F4_FIELDNAME		Field name for value help	20110914
4	Importing	IV_SHLPNAME	Call by reference	☐	Type reference (TYPE)	CBGLE_WB_F4_SEARCHHELPNAME		Name of a search help	20110914
5	Importing	IV_VALUE	Call by reference	☐	Type reference (TYPE)	LVC_VALUE		ALV Control: Cell Content	20110914

Method GET_SHLP_VALUES_BY_SHLP on class CL_EHSGWB_TOOLS has no exception.

Method GET_SHLP_VALUES_BY_TAB_FIELD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_ERRORS	Call by reference	☐	Type reference (TYPE)	BAL_T_MSG		Application Log: Table with Messages	20110914
2	Exporting	ET_VALUES	Call by reference	☐	Type reference (TYPE)	CCGLD_WB_DDSHRETVAL		EHS: Table of DDSHRETVAL	20110914
3	Importing	IV_FIELDNAME	Call by reference	☐	Type reference (TYPE)	CBGLE_WB_F4_FIELDNAME		Field name for value help	20110914
4	Importing	IV_FLG_SUPPRESS_RECORDLIST	Call by reference	☐	Type reference (TYPE)	AS4FLAG	ABAP_FALSE	'X': suppress popup F4-help; ' ': display popup F4-Help	20120228
5	Importing	IV_TABNAME	Call by reference	☐	Type reference (TYPE)	CBGLE_WB_F4_TABNAME		Name of table for value help	20110914
6	Importing	IV_VALUE	Call by reference	☐	Type reference (TYPE)	LVC_VALUE		ALV Control: Cell Content	20110914

Method GET_SHLP_VALUES_BY_TAB_FIELD on class CL_EHSGWB_TOOLS has no exception.

Method GET_STYPE_DESCRIPTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RT_STYPE_DESC	Value transfer	☐	Type reference (TYPE)	DDFIXVALUES		Beschreibung von Domänen-Festwerten	20130108

Method GET_STYPE_DESCRIPTION on class CL_EHSGWB_TOOLS has no exception.

History

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