SAP ABAP Class CL_SALV_IDA_STRUCTDESCR (Wrapper of SADL entity)

Hierarchy

☛ SAP_UI (Software Component) User Interface Technology
   ⤷ BC-SRV-ALV (Application Component) SAP List Viewer
     ⤷ SALV_IDA_ATS (Package) ATS for IDA

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SALV_IDA_STRUCTDESCR_PROV	Wrapper of SADL entity	20130926
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SALV_STC_COL_CONFIGURATOR	Call Back for Column Catalog Consumer	20140303

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	TD_SALV_IDA_STRUCTDESCR	Wrapper of SADL entity	20131130

Properties

Class	CL_SALV_IDA_STRUCTDESCR
Short Description	Wrapper of SADL entity
Super Class
Instantiability of a Class	1	Protected
Final	☐

General Data

Message Class
Program status
Category	0
Package	SALV_IDA_ATS	ATS for IDA
Created	20130808	SAP
Last change	20141121
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	IF_SALV_GUI_TYPES_IDA	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
3	IF_SALV_IDA_STRUCTDESCR_PROV	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
4	IF_SALV_IDA_TYPES	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_SALV_IDA_STRUCTDESCR_PROV	☐	☐	Wrapper of SADL entity	20130926
2	IF_SALV_STC_COL_CONFIGURATOR	☐	☐	Call Back for Column Catalog Consumer	20140303

Friends

#	Friend	Modeled only	Created on	Description
1	TC_SALV_IDA_AUNIT_FRIEND	☐	20140301	Friend of IDA classes for injections in unit tests

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MO_CALC_FIELD_HANDLER	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_SALV_IDA_CALC_FIELD_HANDLER		IDA API: Handler for Calculated Fields	20131016
2	MO_CALC_FIELD_STRUCTDESCR	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_ABAP_STRUCTDESCR		Runtime Type Services	20131016
3	MO_COLUMN_CATALOG	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_SALV_COLUMN_CATALOG			20130926
4	MO_COLUMN_CONFIGURATOR	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_SALV_STC_COL_CONFIGURATOR			20140303
5	MO_DATABASE_RESULT_STRUCTDESCR	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_ABAP_STRUCTDESCR		Runtime Type Services	20130926
6	MO_DATABASE_STRUCTDESCR	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_ABAP_STRUCTDESCR		Runtime Type Services	20130926
7	MO_RESULT_STRUCTDESCR	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_ABAP_STRUCTDESCR			20130926
8	MO_SADL_ENTITY	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_SADL_ENTITY			20130926
9	MS_SADL_ENTITY	Static Attribute	Private	☐	See coding				20140813
10	MS_SADL_VERSION_DEPENDENCY	Static Attribute	Private	☐	See coding				20140813
11	MTS_FIELD_DESCR	Instance attribute	Protected	☐	Type reference (TYPE)	YTS_FIELD_DESCR			20131126
12	MTS_KEY_FIELDS	Instance attribute	Protected	☐	Type reference (TYPE)	IF_SALV_IDA_TYPES=>YTS_FIELD_NAME			20131130
13	MV_DDIC_TABLE_NAME	Instance attribute	Protected	☐	Type reference (TYPE)	DBTABL		Database Table	20130926
14	M_CLIENT_FIELD_NAME	Instance attribute	Protected	☐	Type reference (TYPE)	FIELDNAME			20131115

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	APPEND_FIELD_DESCR_4_CALC_FLDS	Static method	Private	Method		20140813
2	CHECK_AND_ADJUST_SEARCH_SCOPE	Static method	Public	Method		20140811
3	CHECK_CALC_FIELD_STRUCTURE	Static method	Protected	Method		20130926
4	CHECK_FIELD_AND_DATA_ELEMENT	Instance method	Protected	Method		20131017
5	CHECK_RESULT_STRUCTURE	Static method	Protected	Method		20140307
6	CLEAR_COLTYPE	Instance method	Protected	Method		20131130
7	CONFIGURE_COLUMN	Instance method	Protected	Method		20131126
8	CONSTRUCTOR_	Instance method	Protected	Method		20140219
9	CREATE_COLUMN_CATALOG	Instance method	Protected	Method		20131016
10	CREATE_FIELD_DESCR_4_ENTITY	Static method	Private	Method		20140813
11	CREATE_FOR_SADL_ENTITY	Static method	Public	Method		20130926
12	CREATE_FOR_TABLE	Static method	Public	Method		20130926
13	CREATE_RESULT_STRUCTDESCR	Static method	Protected	Method		20131016
14	GET_CLIENT_FIELD_NAME	Static method	Protected	Method		20140804
15	GET_FIELD_DESCR	Instance method	Private	Method		20140804
16	GET_KEY_FIELD_NAMES_FROM_SADL	Static method	Protected	Method		20140804
17	GET_SADL_CONSUMPTION_INFO	Instance method	Protected	Method		20140811
18	GET_STRUCTDESCR_WO_CLNT	Instance method	Protected	Method		20131031
19	GET_TOOLTIP	Static method	Protected	Method		20140804
20	IS_TYPE_COMPATIBLE	Instance method	Protected	Method		20131129

Events

Class CL_SALV_IDA_STRUCTDESCR has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	YS_FIELD_DESCR	Protected	See coding			20140804	begin of ys_field_descr, fieldname type fieldname, keyflag type keyflag, reptext type reptext, fieldtext type fieldtxt, scrtext_s type scrtext_s, scrtext_m type scrtext_m, scrtext_l type scrtext_l, datatype type dynptype, inttype type inttype, leng type ddleng, intlen type intlen, outputlen type outputlen, decimals type decimals, lowercase type lowercase, sign type signflag, reffield type reffield, convexit type convexit, domname type domname, " auxiliary attributes: is_calc_field type abap_bool, sort_as_text type abap_bool, sort_by type if_salv_service_types=>y_property_value, " by internal / external ref_value type y_ref_value, label type text40, "Either CDS or API tooltip type lvc_tip, begin of s_basic_col_format, initial_value_mode type if_salv_service_types=>y_formatting_option_value, sign_position type if_salv_service_types=>y_formatting_option_value, condense type if_salv_service_types=>y_formatting_option_value, time_format type if_salv_service_types=>y_formatting_option_value, end of s_basic_col_format, end of ys_field_descr
2	YTS_FIELD_DESCR	Protected	See coding			20140804	yts_field_descr type sorted table of ys_field_descr with unique key fieldname
3	YT_FIELD_DESCR	Protected	See coding			20140804	yt_field_descr type standard table of ys_field_descr with key fieldname
4	Y_REF_VALUE	Protected	Type reference (TYPE)	CHAR5		20140804

Method Signatures

Method APPEND_FIELD_DESCR_4_CALC_FLDS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_RTTI_API	Call by reference	☐	Object reference (TYPE REF TO)	LCL_DDIC_RTTI_API			20140813
2	Changing	XTS_FIELD_DESCR	Call by reference	☐	Type reference (TYPE)	CL_SALV_IDA_STRUCTDESCR=>YTS_FIELD_DESCR			20140813

Method APPEND_FIELD_DESCR_4_CALC_FLDS on class CL_SALV_IDA_STRUCTDESCR has no exception.

Method CHECK_AND_ADJUST_SEARCH_SCOPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_SADL_ENTITY	Call by reference	☐	Object reference (TYPE REF TO)	IF_SADL_ENTITY			20140811
2	Importing	IV_REMOVE_NON_DB_FIELDS	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL			20140811
3	Importing	IV_REMOVE_NON_SEARCHABLE_FLDS	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL			20140811
4	Changing	XT_FIELD_NAMES	Call by reference	☐	Type reference (TYPE)	STRING_TABLE			20140811

#	Exception	Resumable	Description	Created on
1	CX_SALV_IDA_SEARCH_NOT_SUPP	☐		20140811
2	CX_SALV_IDA_UNKNOWN_NAME	☐		20140811

Method CHECK_CALC_FIELD_STRUCTURE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_CALC_FIELD_STRUCTDESCR	Call by reference	☐	Object reference (TYPE REF TO)	CL_ABAP_STRUCTDESCR			20130926
2	Importing	IO_DATABASE_STRUCTDESCR	Call by reference	☐	Object reference (TYPE REF TO)	CL_ABAP_STRUCTDESCR			20130926

#	Exception	Resumable	Description	Created on
1	CX_SALV_IDA_CONTRACT_VIOLATION	☐	IDA API contract violated by caller	20130926

Method CHECK_FIELD_AND_DATA_ELEMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_DATA_ELEMENT_NAME	Call by reference	☐	Type reference (TYPE)	IF_SALV_GUI_TYPES_IDA=>Y_DATA_ELEMENT_NAME			20131017
2	Importing	IV_FIELD_NAME	Call by reference	☐	Type reference (TYPE)	IF_SALV_GUI_TYPES_IDA=>Y_FIELD_NAME			20131017

#	Exception	Resumable	Description	Created on
1	CX_SALV_IDA_CONTRACT_VIOLATION	☐		20131202

Method CHECK_RESULT_STRUCTURE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_CALC_FIELD_STRUCTDESCR	Call by reference	☐	Object reference (TYPE REF TO)	CL_ABAP_STRUCTDESCR			20140307
2	Importing	IO_DATABASE_STRUCTDESCR	Call by reference	☐	Object reference (TYPE REF TO)	CL_ABAP_STRUCTDESCR			20140307
3	Importing	IO_RESULT_STRUCTDESCR	Call by reference	☐	Object reference (TYPE REF TO)	CL_ABAP_STRUCTDESCR			20140307

#	Exception	Resumable	Description	Created on
1	CX_SALV_IDA_CONTRACT_VIOLATION	☐		20140307

Method CLEAR_COLTYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	XS_FIELD_DESCR	Call by reference	☐	Type reference (TYPE)	CL_SALV_IDA_STRUCTDESCR=>YS_FIELD_DESCR			20131130

Method CLEAR_COLTYPE on class CL_SALV_IDA_STRUCTDESCR has no exception.

Method CONFIGURE_COLUMN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_FIELD_DESCR	Call by reference	☐	Type reference (TYPE)	CL_SALV_IDA_STRUCTDESCR=>YS_FIELD_DESCR			20131126

#	Exception	Resumable	Description	Created on
1	CX_SALV_IDA_CONTRACT_VIOLATION	☐		20131129

Method CONSTRUCTOR_ Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_CALC_FIELD_HANDLER	Call by reference	☑	Object reference (TYPE REF TO)	IF_SALV_IDA_CALC_FIELD_HANDLER			20140219
2	Importing	IO_SADL_ENTITY	Call by reference	☐	Object reference (TYPE REF TO)	IF_SADL_ENTITY			20140219

#	Exception	Resumable	Description	Created on
1	CX_SALV_IDA_CONTRACT_VIOLATION	☐		20140219

Method CREATE_COLUMN_CATALOG Signature

Method CREATE_COLUMN_CATALOG on class CL_SALV_IDA_STRUCTDESCR has no parameter.
Method CREATE_COLUMN_CATALOG on class CL_SALV_IDA_STRUCTDESCR has no exception.

Method CREATE_FIELD_DESCR_4_ENTITY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ETS_FIELD_DESCR	Call by reference	☐	Type reference (TYPE)	CL_SALV_IDA_STRUCTDESCR=>YTS_FIELD_DESCR			20140813
2	Importing	IO_RESULT_STRUCTDESCR	Call by reference	☑	Object reference (TYPE REF TO)	CL_ABAP_STRUCTDESCR			20140813
3	Importing	IO_RTTI_API	Call by reference	☐	Object reference (TYPE REF TO)	LCL_DDIC_RTTI_API			20140813
4	Importing	IO_SADL_ENTITY	Call by reference	☐	Object reference (TYPE REF TO)	IF_SADL_ENTITY			20140813
5	Importing	ITS_KEY_FIELDS	Call by reference	☐	Type reference (TYPE)	IF_SALV_IDA_TYPES=>YTS_FIELD_NAME			20140813
6	Importing	IV_CLIENT_FIELD_NAME	Call by reference	☐	Type reference (TYPE)	FIELDNAME			20140813

Method CREATE_FIELD_DESCR_4_ENTITY on class CL_SALV_IDA_STRUCTDESCR has no exception.

Method CREATE_FOR_SADL_ENTITY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_CALC_FIELD_HANDLER	Call by reference	☑	Object reference (TYPE REF TO)	IF_SALV_IDA_CALC_FIELD_HANDLER		IDA API: Handler for Calculated Fields	20131016
2	Importing	IO_ENTITY	Call by reference	☐	Object reference (TYPE REF TO)	IF_SADL_ENTITY			20130926
3	Returning	RO_STRUCTDESCR	Value transfer	☐	Object reference (TYPE REF TO)	IF_SALV_IDA_STRUCTDESCR_PROV			20131009

#	Exception	Resumable	Description	Created on
1	CX_SALV_IDA_CONTRACT_VIOLATION	☐	IDA API contract violated by caller	20130926

Method CREATE_FOR_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_CALC_FIELD_HANDLER	Call by reference	☑	Object reference (TYPE REF TO)	IF_SALV_IDA_CALC_FIELD_HANDLER		IDA API: Handler for Calculated Fields	20131016
2	Importing	IV_TABLE_NAME	Call by reference	☐	Type reference (TYPE)	DBTABL			20130926
3	Returning	RO_STRUCTDESCR	Value transfer	☐	Object reference (TYPE REF TO)	IF_SALV_IDA_STRUCTDESCR_PROV			20131009

#	Exception	Resumable	Description	Created on
1	CX_SALV_IDA_CONTRACT_VIOLATION	☐	IDA API contract violated by caller	20130926

Method CREATE_RESULT_STRUCTDESCR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_CALC_FIELD_STRUCTDESCR	Call by reference	☐	Object reference (TYPE REF TO)	CL_ABAP_STRUCTDESCR		Runtime Type Services	20131016
2	Importing	IO_DATABASE_RESULT_STRUCTDESCR	Call by reference	☐	Object reference (TYPE REF TO)	CL_ABAP_STRUCTDESCR		Runtime Type Services	20131016
3	Returning	RO_RESULT_STRUCTDESCR	Value transfer	☐	Object reference (TYPE REF TO)	CL_ABAP_STRUCTDESCR		Runtime Type Services	20131016

Method CREATE_RESULT_STRUCTDESCR on class CL_SALV_IDA_STRUCTDESCR has no exception.

Method GET_CLIENT_FIELD_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_ENTITY	Call by reference	☐	Object reference (TYPE REF TO)	IF_SADL_ENTITY			20140804
2	Importing	IV_DDIC_TABLE_NAME	Call by reference	☐	Type reference (TYPE)	DBTABL			20140804
3	Returning	RV_FIELD_NAME	Value transfer	☐	Type reference (TYPE)	FIELDNAME			20140804

Method GET_CLIENT_FIELD_NAME on class CL_SALV_IDA_STRUCTDESCR has no exception.

Method GET_FIELD_DESCR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FIELD_NAME	Value transfer	☐	Type reference (TYPE)	IF_SALV_GUI_TYPES_IDA=>Y_FIELD_NAME			20140804
2	Importing	ONLY_DB_FIELD	Value transfer	☑	Type reference (TYPE)	ABAP_BOOL			20140804
3	Returning	RS_DESCR	Value transfer	☐	Type reference (TYPE)	CL_SALV_IDA_STRUCTDESCR=>YS_FIELD_DESCR			20140804

#	Exception	Resumable	Description	Created on
1	CX_SALV_IDA_UNKNOWN_NAME	☐		20140804

Method GET_KEY_FIELD_NAMES_FROM_SADL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ETS_KEY_FIELDS	Call by reference	☐	Type reference (TYPE)	IF_SALV_IDA_TYPES=>YTS_FIELD_NAME			20140804
2	Importing	IO_ENTITY	Call by reference	☐	Object reference (TYPE REF TO)	IF_SADL_ENTITY			20140804
3	Importing	IV_CLIENT_FIELD_NAME	Call by reference	☐	Type reference (TYPE)	FIELDNAME			20140804

Method GET_KEY_FIELD_NAMES_FROM_SADL on class CL_SALV_IDA_STRUCTDESCR has no exception.

Method GET_SADL_CONSUMPTION_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_SADL_CONSUMPTION_INFO	Value transfer	☐	Object reference (TYPE REF TO)	IF_SADL_ENTITY_CONSUMP_INFO			20140811

Method GET_SADL_CONSUMPTION_INFO on class CL_SALV_IDA_STRUCTDESCR has no exception.

Method GET_STRUCTDESCR_WO_CLNT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_ENTITY	Call by reference	☐	Object reference (TYPE REF TO)	IF_SADL_ENTITY			20131115
2	Importing	IV_CLIENT_FIELD_NAME	Call by reference	☐	Type reference (TYPE)	FIELDNAME			20131115
3	Importing	IV_DDIC_TABLE_NAME	Call by reference	☐	Type reference (TYPE)	DBTABL			20140213
4	Returning	RO_STRUCTDESCR	Value transfer	☐	Object reference (TYPE REF TO)	CL_ABAP_STRUCTDESCR		Runtime Type Services	20131031

Method GET_STRUCTDESCR_WO_CLNT on class CL_SALV_IDA_STRUCTDESCR has no exception.

Method GET_TOOLTIP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_DFIES	Call by reference	☐	Type reference (TYPE)	CL_SALV_IDA_STRUCTDESCR=>YS_FIELD_DESCR			20140804
2	Returning	R_TOOLTIP	Value transfer	☐	Type reference (TYPE)	REPTEXT			20140804

Method GET_TOOLTIP on class CL_SALV_IDA_STRUCTDESCR has no exception.

Method IS_TYPE_COMPATIBLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_DDIC_FIELD	Call by reference	☐	Type reference (TYPE)	DFIES			20131129
2	Importing	IV_FIELD_NAME	Call by reference	☐	Type reference (TYPE)	IF_SALV_GUI_TYPES_IDA=>Y_FIELD_NAME			20131129
3	Returning	RV_IS_COMPATIBLE	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20131129

Method IS_TYPE_COMPATIBLE on class CL_SALV_IDA_STRUCTDESCR has no exception.

History

Last changed by/on	SAP	20141121
SAP Release Created in	740