SAP ABAP Class CL_FOX3_SIMPLE_EXPLODER (Main Class for Simple Explosions)

Hierarchy

☛ SAP_BS_FND (Software Component) SAP Business Suite Foundation
   ⤷ CA-MDG-DRF (Application Component) Data Replication Framework
     ⤷ FOX3 (Package) Framework for hierarchy explosion

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_FOX3_FREEABLE_OBJECT	ObjeCt with Free_Data Method	20100514
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_PTU_HAS_UTILITY_OBJECTS	Object Has Help Objects	20100514

Properties

Class	CL_FOX3_SIMPLE_EXPLODER
Short Description	Main Class for Simple Explosions
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	FOX3	Framework for hierarchy explosion
Created	20100514	SAP
Last change	20110908	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	CFOX3	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
2	CL_FOX3_CONSTANTS	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_FOX3_FREEABLE_OBJECT	☐	☐	ObjeCt with Free_Data Method	20100514
2	IF_PTU_HAS_UTILITY_OBJECTS	☐	☐	Object Has Help Objects	20100514

Friends

Class CL_FOX3_SIMPLE_EXPLODER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_TAG	Constant	Protected	☐	Type reference (TYPE)	PTU_TAG	CL_FOX3_CONSTANTS=>GC_TAG_EXPLODER	Indicator	20100514
2	GI_PARAMETERS	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_FOX3_PARAMETERS		Parameters for Explosion	20100514
3	GI_SELECTOR	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_FOX3_FLOB_SELECTOR		Information Retrieval for FOX File	20100514
4	GI_UI_SERVICE	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_FOX3_UI_SERVICE		Interface for User Interface Components	20100514
5	GO_CONTROLLER	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_FOX3_CONTROLLER		Control Unit for the Explosion	20100514
6	GO_DB_SELECTOR	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_FOX3_FLOB_DB_SELECTOR		Database Access to FOX File	20100514
7	GO_LAST_MLS	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_FOX3_MULTILEVEL_STRUCTURE		Multilevel Object Structure	20100514
8	GO_LIST_DUMP	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_FOX3_LIST_DUMP		List Display for Object Structure	20100514
9	GO_MEMORY_SELECTOR	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_FOX3_FLOB_MEMORY_SELECTOR		Memory Accesses for a FOX File	20100514
10	GS_DISPLAY_OPTIONS	Instance attribute	Protected	☐	Type reference (TYPE)	FOX3_DISPLAY_OPTIONS_S			20100514
11	GS_UTIL_IF	Instance attribute	Protected	☐	Attribute reference (LIKE)			Structure with Utility Interface	20100514
12	GT_CLASSES	Instance attribute	Protected	☐	Type reference (TYPE)	FOX3_STRUCTURED_CLASS_T		Table of Implementations for cl_fox_structured_object	20100514
13	GT_LINK_TYPE_TX	Instance attribute	Protected	☐	Type reference (TYPE)	FOX3_LINK_TYPE_TX_T		Link Types and Texts	20100514
14	GT_OBJECT_TYPE_TX	Instance attribute	Protected	☐	Type reference (TYPE)	FOX3_OBJECT_TYPE_TX_T		Object Types and Text	20100514
15	GV_FREED	Instance attribute	Public	☐	Attribute reference (LIKE)				20100514
16	GV_NUM_OBJECTS	Instance attribute	Protected	☐	Type reference (TYPE)	SY-INDEX		Loops, Current Loop Pass	20100514
17	GV_STRUCT_ID	Instance attribute	Public	☑	Type reference (TYPE)	FOX3_STRUCT_DB_ID		Database ID of a FOX Cache	20100514
18	GV_SUM_OBJECTS	Instance attribute	Protected	☐	Type reference (TYPE)	SY-INDEX		Loops, Current Loop Pass	20100514
19	SV_MSG_DUMMY	Static Attribute	Protected	☐	Type reference (TYPE)	CHAR1		Single-Character Indicator	20100514
20	SV_MSG_LINK_TYPE_EXT	Static Attribute	Protected	☐	Type reference (TYPE)	FOX3_LINK_TYPE_EXT		External Format of Object Relationship	20100514
21	SV_MSG_OBJ_KEY_EXT	Static Attribute	Protected	☐	Type reference (TYPE)	FOX3_OBJ_KEY_EXT		External Object Key (Such As Material or BOM)	20100514
22	SV_MSG_OBJ_TYPE_EXT	Static Attribute	Protected	☐	Type reference (TYPE)	FOX3_OBJ_TYPE_EXT		External Format of Object Type	20100514

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ANALYZE	Instance method	Public	Method	Analysis of Explosion	20100514
2	CHECK_LOG	Instance method	Protected	Method	Application Log Check	20100514
3	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20100514
4	CREATE_UI_SERVICE	Instance method	Protected	Method	Instantiate User Interface Services	20100514
5	DELETE_EXPLOSION	Instance method	Public	Method	Delete Explosion	20100514
6	EXPLODE_OBJECTS	Instance method	Public	Method	Explode Objects	20100514
7	FREE_DATA	Instance method	Public	Method		20100514
8	GET_DB_SELECTOR	Instance method	Protected	Method	Instantiate Database Selector	20100514
9	GET_OPTIONS	Instance method	Public	Method	Output Settings	20100514
10	GET_UTILITIES	Instance method	Public	Method	Export Help Classes	20100514
11	LOG_STATISTIC	Instance method	Protected	Method	Output Statistical Information	20100514
12	POST_EXPLOSION_PROCESSING	Instance method	Protected	Method	Method Call After Each Explosion	20100514
13	READ_OBJECTS	Instance method	Public	Method	Import Exploded Objects	20100514
14	SAVE_EXPLOSION	Instance method	Public	Method	Save Explosion	20100514
15	SET_OPTIONS	Instance method	Public	Method	Change Settings	20100514
16	SHOW_LOG	Instance method	Public	Method	Display Application Log	20100514
17	UPDATE_UTILITIES	Instance method	Public	Method		20100514
18	WRITE_EXPLOSION_INFORMATION	Instance method	Protected	Method	Output Information on Last Explosion	20100514

Events

Class CL_FOX3_SIMPLE_EXPLODER has no event.

Types

Class CL_FOX3_SIMPLE_EXPLODER has no local type.

Method Signatures

Method ANALYZE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CV_IGNORE_LINK_TYPE	Call by reference	☐	Type reference (TYPE)	FOX3_IGNORE_LINK_TYPE	'X'	Ignore Object Relationships	20100514
2	Importing	IS_LINKED_OBJECT_DB	Call by reference	☑	Type reference (TYPE)	FOX3_LINKED_OBJECT_DB_S		Object ID and Relationship at Database Level	20100514
3	Importing	IT_TITLE_TEXT	Call by reference	☑	Type reference (TYPE)	FOX3_TITLE_TEXT_T		Text for List Headers	20100514
4	Importing	IV_ALL_EXPLOSIONS	Call by reference	☑	Type reference (TYPE)	FLAG_X		All Explosions	20100514
5	Importing	IV_ASK_BEFORE_LEAVE	Call by reference	☐	Type reference (TYPE)	FLAG_X	'X'	Query Before Exit	20100514
6	Importing	IV_FIRST_SCREEN	Call by reference	☑	Type reference (TYPE)	SYUCOMM		Screens, Function Code Triggered by PAI	20100514
7	Importing	IV_STRUCTURE	Call by reference	☑	Object reference (TYPE REF TO)	CL_FOX3_MULTILEVEL_STRUCTURE		Multilevel Object Structure	20100514

#	Exception	Resumable	Description	Created on
1	ANALYSIS_ERROR	☐	Error in Analysis	20100514
2	CREATE_ERROR	☐	Error During Instantiation	20100514
3	INVALID_REFERENCE	☐	Invalid Reference	20100514
4	NOTHING_TO_ANALYZE	☐	Unable to Execute Analysis	20100514
5	TOO_MANY_PARAMETERS	☐	Too many Parameters	20100514

Method CHECK_LOG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_MOST_SEVERE_MSGTY	Call by reference	☐	Type reference (TYPE)	BALMSGTY		Application Log: Message Type (A,E,W,I,S)	20100514

Method CHECK_LOG on class CL_FOX3_SIMPLE_EXPLODER has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	II_PARAMETERS	Call by reference	☑	Object reference (TYPE REF TO)	IF_FOX3_PARAMETERS		Parameters for Explosion	20100514
2	Importing	IS_DISPLAY_OPTIONS	Call by reference	☑	Type reference (TYPE)	FOX3_DISPLAY_OPTIONS_S		Display Parameters for Structure Explosion	20100514
3	Importing	IS_UTIL_IF	Call by reference	☑	Type reference (TYPE)	PTU_UTIL_IF_S		Structure with Utility Interfaces	20100514
4	Importing	IT_CLASSES	Call by reference	☑	Type reference (TYPE)	FOX3_STRUCTURED_CLASS_T		Table of Implementations for cl_fox_structured_object	20100514
5	Importing	IT_LINK_TYPE_TX	Call by reference	☑	Type reference (TYPE)	FOX3_LINK_TYPE_TX_T		Link Types and Texts	20100514
6	Importing	IT_OBJECT_TYPE_TX	Call by reference	☑	Type reference (TYPE)	FOX3_OBJECT_TYPE_TX_T		Object Types and Text	20100514
7	Importing	IV_STRUCT_ID	Call by reference	☑	Type reference (TYPE)	FOX3_STRUCT_DB_ID		Database ID of a FOX Cache	20100514
8	Importing	IV_TOTAL_OBJECTS	Call by reference	☐	Type reference (TYPE)	I	1	Total Number of Explosions	20100514
9	Importing	IV_TRACE_LEVEL	Call by reference	☑	Type reference (TYPE)	PTU_TRACE_LEVEL		Trace Level	20100514

Method CONSTRUCTOR on class CL_FOX3_SIMPLE_EXPLODER has no exception.

Method CREATE_UI_SERVICE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EI_UI_SERVICE	Call by reference	☐	Object reference (TYPE REF TO)	IF_FOX3_UI_SERVICE		Interface for User Interface Components	20100514

#	Exception	Resumable	Description	Created on
1	CREATE_ERROR	☐	Error During Instantiation	20100514

Method DELETE_EXPLOSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EO_CONTROLLER	Call by reference	☐	Object reference (TYPE REF TO)	CL_FOX3_CONTROLLER		Control Unit for the Explosion	20100514

#	Exception	Resumable	Description	Created on
1	REFERENCE_IS_USED	☐	Reference Is Still Used	20100514
2	REFERENCE_NOT_VALID	☐	Invalid Reference	20100514

Method EXPLODE_OBJECTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_STRUCTURE	Call by reference	☐	Type reference (TYPE)	FOX3_STRUCTURE_NOSORT_T		Multilevel Object Structure	20100514
2	Exporting	EV_FIRST_ERROR	Call by reference	☐	Type reference (TYPE)	SY-INDEX		Index Where Error Occurred	20100514
3	Exporting	EV_MOST_SEVERE_MSGTY	Call by reference	☐	Type reference (TYPE)	BALMSGTY		Application Log: Message Type (A,E,W,I,S)	20100514
4	Importing	IT_LINKED_KEY	Call by reference	☐	Type reference (TYPE)	FOX3_LINKED_KEY_T		Object Type, Key, and Link Color	20100514

#	Exception	Resumable	Description	Created on
1	ALREADY_SAVED	☐	Data Has Aleady Been Saved	20100514
2	WRONG_CALL	☐	Invalid Call	20100514

Method FREE_DATA Signature

Method FREE_DATA on class CL_FOX3_SIMPLE_EXPLODER has no parameter.
Method FREE_DATA on class CL_FOX3_SIMPLE_EXPLODER has no exception.

Method GET_DB_SELECTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EO_SELECTOR	Call by reference	☐	Object reference (TYPE REF TO)	CL_FOX3_FLOB_DB_SELECTOR		Database Access to FOX File	20100514
2	Importing	IO_LIST_DUMP	Call by reference	☐	Object reference (TYPE REF TO)	CL_FOX3_LIST_DUMP		List Display for Object Structure	20100514
3	Importing	IS_REFERENCE	Call by reference	☐	Type reference (TYPE)	FOX3_PERSISTENT_ENTRY_S		Reference to Persistent Structure	20100514
4	Importing	IV_ALL_EXPLOSIONS	Call by reference	☐	Type reference (TYPE)	FLAG_X		All Explosions	20100514

#	Exception	Resumable	Description	Created on
1	CREATE_ERROR	☐	Error in Analysis	20100514

Method GET_OPTIONS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_DISPLAY_OPTIONS	Call by reference	☐	Type reference (TYPE)	FOX3_DISPLAY_OPTIONS_S		Display Parameters for Structure Explosion	20100514

Method GET_OPTIONS on class CL_FOX3_SIMPLE_EXPLODER has no exception.

Method GET_UTILITIES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_UTIL_IF	Call by reference	☐	Type reference (TYPE)	PTU_UTIL_IF_S		Structure with Utility Interfaces	20100514

Method GET_UTILITIES on class CL_FOX3_SIMPLE_EXPLODER has no exception.

Method LOG_STATISTIC Signature

Method LOG_STATISTIC on class CL_FOX3_SIMPLE_EXPLODER has no parameter.

#	Exception	Resumable	Description	Created on
1	NO_DISPLAY	☐	Hidden	20100514

Method POST_EXPLOSION_PROCESSING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_INST_STRUCTURE	Call by reference	☐	Type reference (TYPE)	FOX3_PARENT_OBJECT_T		Parent Object Table for the FOX Caller	20100514

#	Exception	Resumable	Description	Created on
1	NO_DISPLAY	☐	Hidden	20100514

Method READ_OBJECTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_STRUCTURE	Call by reference	☐	Type reference (TYPE)	FOX3_STRUCTURE_NOSORT_T		Table of Exploded Instances	20100514
2	Exporting	EV_ERROR_INDEX	Call by reference	☐	Type reference (TYPE)	SYINDEX		Index Where Error Occurred	20100514
3	Exporting	EV_MOST_SEVERE_MSGTY	Call by reference	☐	Type reference (TYPE)	BALMSGTY		Application Log: Message Type (A,E,W,I,S)	20100514
4	Importing	IT_LINKED_OBJECT_DB	Call by reference	☐	Type reference (TYPE)	FOX3_LINKED_OBJECT_DB_NOSORT_T		Object ID and Relationship at Database Level	20100514

#	Exception	Resumable	Description	Created on
1	REFERENCE_NOT_VALID	☐	Invalid Reference	20100514
2	WRONG_CALL	☐	Invalid Call	20100514

Method SAVE_EXPLOSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_LAST_REFERENCE	Call by reference	☐	Type reference (TYPE)	FOX3_PERSISTENT_ENTRY_S		Reference to Persistent Structure	20100514

#	Exception	Resumable	Description	Created on
1	NOTHING_TO_SAVE	☐	No Explosion Available	20100514

Method SET_OPTIONS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_DISPLAY_OPTIONS	Call by reference	☐	Type reference (TYPE)	FOX3_DISPLAY_OPTIONS_S		Display Parameters for Structure Explosion	20100514

Method SET_OPTIONS on class CL_FOX3_SIMPLE_EXPLODER has no exception.

Method SHOW_LOG Signature

Method SHOW_LOG on class CL_FOX3_SIMPLE_EXPLODER has no parameter.
Method SHOW_LOG on class CL_FOX3_SIMPLE_EXPLODER has no exception.

Method UPDATE_UTILITIES Signature

Method UPDATE_UTILITIES on class CL_FOX3_SIMPLE_EXPLODER has no parameter.
Method UPDATE_UTILITIES on class CL_FOX3_SIMPLE_EXPLODER has no exception.

Method WRITE_EXPLOSION_INFORMATION Signature

Method WRITE_EXPLOSION_INFORMATION on class CL_FOX3_SIMPLE_EXPLODER has no parameter.

#	Exception	Resumable	Description	Created on
1	NO_DISPLAY	☐	Hidden	20100514

History

Last changed by/on	SAP	20110908
SAP Release Created in