SAP ABAP Class CL_FPM_SADL_BUILDER (FPM SADL Join Builder)

Hierarchy

☛ SAP_UI (Software Component) User Interface Technology
   ⤷ BC-WD-CMP-FPM (Application Component) Floorplan Manager Web Dynpro ABAP
     ⤷ SAPB_FPM_SADL (Package) SADL Adapter

Properties

Class	CL_FPM_SADL_BUILDER
Short Description	FPM SADL Join Builder
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	SAPB_FPM_SADL	SADL Adapter
Created	20121030	SAP
Last change	20141120
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_SADL_ENTITY_CONSUMP_INFO	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
3	IF_SADL_ENTITY_FACTORY	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
4	IF_SADL_TYPES	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

Class CL_FPM_SADL_BUILDER has no interface implemented.

Friends

Class CL_FPM_SADL_BUILDER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CS_SCOPE	Constant	Public	☐	See coding				20140224
2	CV_ENTITY_TYPE_SADL	Constant	Private	☐	Type reference (TYPE)	SADL_ENTITY_TYPE	'SADL'	Name of SADL_ENTITY_TYPE	20121102
3	CV_SADL_STRUCTURE_NAME	Constant	Public	☐	Type reference (TYPE)	IF_SADL_TYPES=>TY_SADL_STRUCTURE-NAME	'ROOT'		20121213
4	MO_SADL_ENTITY_API	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_SADL_ENTITY_API		SADL Entity API	20130108
5	MT_ACTION	Instance attribute	Public	☑	Type reference (TYPE)	T_ACTION			20140108
6	MT_ATTRIBUTE	Instance attribute	Public	☑	Type reference (TYPE)	T_ATTRIBUTE			20121030
7	MT_JOIN	Instance attribute	Private	☐	Type reference (TYPE)	T_JOIN			20121030
8	MV_ENTITY_TYPE	Instance attribute	Private	☐	Type reference (TYPE)	SADL_ENTITY_TYPE		Name of SADL_ENTITY_TYPE	20121030
9	MV_FINISHIED	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL			20130108
10	MV_ROOT_ENTITY_ID	Instance attribute	Private	☐	Type reference (TYPE)	SADL_ENTITY_ID		Name of SADL_ENTITY_ID	20121031
11	MV_SCOPE	Instance attribute	Private	☐	Type reference (TYPE)	FPM_SADL_SCOPE			20140224

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	BUILD_SADL_ID	Instance method	Private	Method		20121204
2	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20121030
3	FINISH	Instance method	Public	Method		20130108
4	GET_ATTRIBUTE_NAME	Instance method	Public	Method		20121213
5	GET_ENTITY_ACTIONS	Instance method	Private	Method		20140107
6	GET_ENTITY_ATTRIBUTES	Instance method	Private	Method		20121030
7	GET_ENTITY_CONSUMPTION_INFO	Instance method	Private	Method		20140220
8	GET_PATH	Instance method	Public	Method		20121213
9	GET_SADL_ENTITY_API	Instance method	Public	Method		20130108
10	GET_SADL_OBJECT_NAME	Instance method	Private	Method		20140107
11	IS_CONSUMPTION_ALLOWED	Instance method	Private	Method		20140220
12	IS_TRANSACTIONAL_ALLOWED	Instance method	Private	Method		20140220
13	JOIN	Instance method	Public	Method		20121030
14	SADL_ESCAPE	Instance method	Private	Method		20130712
15	VALUE_HELP_ENTITY_TYPE	Static method	Public	Method		20140314

Events

Class CL_FPM_SADL_BUILDER has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	FPM_SADL_SCOPE	Public	See coding			20140314	fpm_sadl_scope TYPE c LENGTH 2
2	S_ACTION	Public	See coding			20140108	BEGIN OF s_action, event_id TYPE fpm_event_id, join_id TYPE string, action_name TYPE sadl_entity_action, data_type TYPE string, description TYPE string, END OF s_action
3	S_ATTRIBUTE	Public	See coding			20121030	BEGIN OF s_attribute, name TYPE name_komp, join_id TYPE string, element_name TYPE sadl_entity_element, is_key TYPE abap_bool, data_type TYPE string, sadl_query_allowed TYPE abap_bool, text_search_allowed TYPE abap_bool, transactional TYPE abap_bool, description TYPE string, END OF s_attribute
4	S_JOIN	Private	See coding			20121030	BEGIN OF s_join, id TYPE string, path TYPE string, entity_id TYPE sadl_entity_id, suffix TYPE dd_suffix, excl_metadata type fpm_sadl_join_exclude_metadata, excl_textsearch type fpm_sadl_join_excl_text_search, END OF s_join
5	T_ACTION	Public	See coding			20140108	t_action TYPE STANDARD TABLE OF s_action WITH UNIQUE SORTED KEY event_id COMPONENTS event_id
6	T_ATTRIBUTE	Public	See coding			20121030	t_attribute TYPE STANDARD TABLE OF s_attribute WITH UNIQUE SORTED KEY name COMPONENTS name
7	T_JOIN	Private	See coding			20121030	t_join TYPE SORTED TABLE OF s_join WITH UNIQUE KEY id WITH NON-UNIQUE SORTED KEY path COMPONENTS path

Method Signatures

Method BUILD_SADL_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_ID	Value transfer	☐	Type reference (TYPE)	IF_SADL_TYPES=>TY_UUID			20121204

Method BUILD_SADL_ID on class CL_FPM_SADL_BUILDER has no exception.

Method CONSTRUCTOR 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)	SADL_ENTITY_ID		Name of SADL_ENTITY_ID	20121030
2	Importing	IV_SCOPE	Call by reference	☐	Type reference (TYPE)	FPM_SADL_SCOPE	CS_SCOPE-SADL_QUERY		20140224
3	Importing	IV_TYPE	Call by reference	☐	Type reference (TYPE)	SADL_ENTITY_TYPE		Name of SADL_ENTITY_TYPE	20121030

#	Exception	Resumable	Description	Created on
1	CX_FPM_SADL	☐	FPM-SADL Exception	20121030

Method FINISH Signature

Method FINISH on class CL_FPM_SADL_BUILDER has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_FPM_SADL	☐	FPM-SADL Exception	20130108

Method GET_ATTRIBUTE_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ELEMENT_NAME	Call by reference	☐	Type reference (TYPE)	SADL_ENTITY_ELEMENT		Name of SADL_ENTITY_ELEMENT	20121213
2	Importing	IV_PATH	Call by reference	☐	Type reference (TYPE)	STRING			20121213
3	Returning	RV_NAME	Value transfer	☐	Type reference (TYPE)	NAME_KOMP		Component name	20121213

Method GET_ATTRIBUTE_NAME on class CL_FPM_SADL_BUILDER has no exception.

Method GET_ENTITY_ACTIONS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_ENTITY_CI	Call by reference	☐	Object reference (TYPE REF TO)	IF_SADL_ENTITY_CONSUMP_INFO			20140107
2	Importing	IV_JOIN_ID	Call by reference	☑	Type reference (TYPE)	STRING			20140107
3	Importing	IV_SUFFIX	Call by reference	☑	Type reference (TYPE)	DD_SUFFIX		Field name suffix in the ABAP/4 Dictionary	20140107

#	Exception	Resumable	Description	Created on
1	CX_FPM_SADL	☐	FPM-SADL Exception	20140107
2	CX_SADL_ENTITY	☐	cx_sadl_entity	20140107

Method GET_ENTITY_ATTRIBUTES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_ENTITY_CI	Call by reference	☐	Object reference (TYPE REF TO)	IF_SADL_ENTITY_CONSUMP_INFO			20130206
2	Importing	IV_EXCL_TEXTSEARCH	Call by reference	☐	Type reference (TYPE)	FPM_SADL_JOIN_EXCL_TEXT_SEARCH	ABAP_FALSE	FPM SADL: Exclude Join from Metadata	20140324
3	Importing	IV_JOIN_ID	Call by reference	☑	Type reference (TYPE)	STRING			20121030
4	Importing	IV_SUFFIX	Call by reference	☑	Type reference (TYPE)	DD_SUFFIX		Field name suffix in the ABAP/4 Dictionary	20121030

#	Exception	Resumable	Description	Created on
1	CX_FPM_SADL	☐	FPM-SADL Exception	20121030
2	CX_SADL_ENTITY	☐	cx_sadl_entity	20121031

Method GET_ENTITY_CONSUMPTION_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CHECK_SCOPE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20140220
2	Importing	IV_ENTITY_ID	Call by reference	☐	Type reference (TYPE)	SADL_ENTITY_ID		Name of SADL_ENTITY_ID	20140220
3	Returning	RO_ENTTIY_CONSUMPTION_INFO	Value transfer	☐	Object reference (TYPE REF TO)	IF_SADL_ENTITY_CONSUMP_INFO		Consumption information for an SADL Entity	20140220

#	Exception	Resumable	Description	Created on
1	CX_FPM_SADL	☐	FPM-SADL Exception	20140220

Method GET_PATH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_NAME	Call by reference	☐	Type reference (TYPE)	NAME_KOMP		Component name	20121213
2	Returning	RV_PATH	Value transfer	☐	Type reference (TYPE)	STRING			20121213

Method GET_PATH on class CL_FPM_SADL_BUILDER has no exception.

Method GET_SADL_ENTITY_API Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_SADL_ENTITY_API	Value transfer	☐	Object reference (TYPE REF TO)	IF_SADL_ENTITY_API		SADL Entity API	20130108

Method GET_SADL_ENTITY_API on class CL_FPM_SADL_BUILDER has no exception.

Method GET_SADL_OBJECT_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ELEMENT_NAME	Call by reference	☐	Type reference (TYPE)	SADL_ENTITY_ELEMENT		Name of SADL_ENTITY_ELEMENT	20140107
2	Importing	IV_SUFFIX	Call by reference	☐	Type reference (TYPE)	DD_SUFFIX		Field name suffix in the ABAP/4 Dictionary	20140107
3	Returning	RV_NAME	Value transfer	☐	Type reference (TYPE)	CHAR30		ABAP Name	20140107

Method GET_SADL_OBJECT_NAME on class CL_FPM_SADL_BUILDER has no exception.

Method IS_CONSUMPTION_ALLOWED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_CONSUMPTION_INFO	Call by reference	☐	Type reference (TYPE)	IF_SADL_ENTITY_CONSUMP_INFO=>TY_CONSUMPTION_INFORMATION			20140220
2	Importing	IV_RAISE_EXCEPTION	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20140220
3	Returning	RV_ALLOWED	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20140220

#	Exception	Resumable	Description	Created on
1	CX_FPM_SADL	☐	FPM-SADL Exception	20140314

Method IS_TRANSACTIONAL_ALLOWED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_CONSUMPTION_INFO	Call by reference	☐	Type reference (TYPE)	IF_SADL_ENTITY_CONSUMP_INFO=>TY_CONSUMPTION_INFORMATION			20140220
2	Importing	IV_RAISE_EXCEPTION	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20140220
3	Returning	RV_ALLOWED	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20140220

#	Exception	Resumable	Description	Created on
1	CX_FPM_SADL	☐	FPM-SADL Exception	20140314

Method JOIN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ASSOCIATION	Call by reference	☐	Type reference (TYPE)	SADL_ENTITY_ASSOCIATION		Name of SADL_ENTITY_ASSOCIATION	20121030
2	Importing	IV_EXCL_METADATA	Call by reference	☐	Type reference (TYPE)	FPM_SADL_JOIN_EXCLUDE_METADATA	ABAP_FALSE	FPM SADL: Exclude Join from Metadata	20140324
3	Importing	IV_EXCL_TEXTSEARCH	Call by reference	☐	Type reference (TYPE)	FPM_SADL_JOIN_EXCL_TEXT_SEARCH	ABAP_FALSE	FPM SADL: Exclude Join from Metadata	20140324
4	Importing	IV_JOIN_ID	Call by reference	☐	Type reference (TYPE)	STRING			20121030
5	Importing	IV_PARENT_JOIN_ID	Call by reference	☑	Type reference (TYPE)	STRING			20121030
6	Importing	IV_SUFFIX	Call by reference	☑	Type reference (TYPE)	DD_SUFFIX		Field name suffix in the ABAP/4 Dictionary	20121030

#	Exception	Resumable	Description	Created on
1	CX_FPM_SADL	☐	FPM-SADL Exception	20121030
2	CX_SADL_ENTITY	☐	cx_sadl_entity	20121031
3	CX_SADL_STATIC	☐	External errors during SADL processing	20130123

Method SADL_ESCAPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_INPUT	Call by reference	☐	Type reference (TYPE)	CLIKE			20130712
2	Returning	RV_OUTPUT	Value transfer	☐	Type reference (TYPE)	STRING			20130712

Method SADL_ESCAPE on class CL_FPM_SADL_BUILDER has no exception.

Method VALUE_HELP_ENTITY_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_SCOPE	Call by reference	☐	Type reference (TYPE)	FPM_SADL_SCOPE			20140314
2	Returning	RT_ENTITY_TYPE	Value transfer	☐	Type reference (TYPE)	IF_SADL_ENTITY_FACTORY=>TT_VALUE_HELP			20140314

Method VALUE_HELP_ENTITY_TYPE on class CL_FPM_SADL_BUILDER has no exception.

History

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