SAP ABAP Class CL_FOX3_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_DATA_UPDATER	Object Updates Data	20100514
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_FOX3_FREEABLE_OBJECT	ObjeCt with Free_Data Method	20100514
3	Interface implementation (CLASS c. INTERFACES i_ref)	IF_FOX3_MEMORY_AWARE_OBJECT	Read Memory Consumption	20100514
4	Interface implementation (CLASS c. INTERFACES i_ref)	IF_FOX3_MSG_PARAMETER	Parameters for FOX Messages	20100514
5	Interface implementation (CLASS c. INTERFACES i_ref)	IF_FOX3_PERSISTENCE_PARAMETERS	Control of Persistence	20100514
6	Interface implementation (CLASS c. INTERFACES i_ref)	IF_PTU_HAS_UTILITY_OBJECTS	Object Has Help Objects	20100514

Properties

Class	CL_FOX3_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)
3	CL_FOX3_VALIDITY_CONTROLLER	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
4	CL_PTU_PROGRESS_INDICATOR	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_FOX3_DATA_UPDATER	☐	☐	Object Updates Data	20100514
2	IF_FOX3_FREEABLE_OBJECT	☐	☐	ObjeCt with Free_Data Method	20100514
3	IF_FOX3_MEMORY_AWARE_OBJECT	☐	☐	Read Memory Consumption	20100514
4	IF_FOX3_MSG_PARAMETER	☐	☐	Parameters for FOX Messages	20100514
5	IF_FOX3_PERSISTENCE_PARAMETERS	☐	☐	Control of Persistence	20100514
6	IF_PTU_HAS_UTILITY_OBJECTS	☐	☐	Object Has Help Objects	20100514

Friends

Class CL_FOX3_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_PERSISTENCE_CONTROLLER	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_FOX3_PERSISTENCE_CONTROLLER		Control of Persistence	20100514
3	GI_SELECTOR	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_FOX3_FLOB_SELECTOR		Information Retrieval for FOX File	20100514
4	GO_CONTROLLER2	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_FOX3_CONTROLLER		Control Unit for the Explosion	20100514
5	GO_DB_SELECTOR	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_FOX3_FLOB_DB_SELECTOR		Database Access to FOX File	20100514
6	GO_LIST_DUMP2	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_FOX3_LIST_DUMP		List Display for Object Structure	20100514
7	GO_MEMORY_SELECTOR	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_FOX3_FLOB_MEMORY_SELECTOR		Memory Accesses for a FOX File	20100514
8	GO_PROFILE	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_FOX0_PROFILE		Parameters for Explosion	20100514
9	GS_DISPLAY_OPTIONS	Instance attribute	Protected	☐	Type reference (TYPE)	FOX3_DISPLAY_OPTIONS_S			20100514
10	GS_EXPL_STATISTIC	Instance attribute	Protected	☐	Type reference (TYPE)	FOX3_EXPL_NUMBERS_S		Statistical Information for Explosion	20100514
11	GS_MSG_PARAMETERS	Instance attribute	Protected	☐	Attribute reference (LIKE)				20100514
12	GS_TOTAL_STATISTIC	Instance attribute	Protected	☐	Type reference (TYPE)	FOX3_EXPL_NUMBERS_S		Statistical Information for Explosion	20100514
13	GS_UTIL_IF	Instance attribute	Protected	☐	Attribute reference (LIKE)			Structure with Utility Interfaces	20100514
14	GV_DELETE_EXTENT	Instance attribute	Protected	☐	Attribute reference (LIKE)				20100514
15	GV_FORCE_DELETE	Instance attribute	Protected	☐	Attribute reference (LIKE)				20100514
16	GV_FREED	Instance attribute	Public	☐	Attribute reference (LIKE)				20100514
17	GV_PROFILE	Instance attribute	Protected	☐	Type reference (TYPE)	FOX0_PROFILE		FOX Explosion Profile	20100514
18	GV_REQUEST_ID	Instance attribute	Protected	☐	Type reference (TYPE)	FOX3_REQUEST_ID		FOX Request ID	20100514
19	GV_STRUCT_ID	Instance attribute	Protected	☐	Type reference (TYPE)	FOX3_STRUCT_DB_ID		Database ID of a FOX Cache	20100514
20	GV_TA_TYPE	Instance attribute	Protected	☐	Attribute reference (LIKE)				20100514
21	SV_MSG_DUMMY	Instance attribute	Protected	☐	Attribute reference (LIKE)			Single-Character Indicator	20100514
22	SV_MSG_LINK_TYPE_EXT	Instance attribute	Protected	☐	Attribute reference (LIKE)			External Format of Object Relationship	20100514
23	SV_MSG_OBJ_KEY_EXT	Instance attribute	Protected	☐	Attribute reference (LIKE)			External Object Key (Such As Material or BOM)	20100514
24	SV_MSG_OBJ_TYPE_EXT	Instance attribute	Protected	☐	Attribute reference (LIKE)			External Format of Object Type	20100514
25	SV_MSG_OBJ_VERSION	Instance attribute	Protected	☐	Attribute reference (LIKE)			Object Version	20100514
26	SV_NO_DISPLAY	Static Attribute	Protected	☐	Type reference (TYPE)	FLAG_X		Hidden	20100514

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ANALYZE	Instance method	Public	Method	Analysis of Explosion	20100514
2	CLASS_CONSTRUCTOR	Static method	Public	Constructor	CLASS_CONSTRUCTOR	20100514
3	COLLECT_FOREIGN_KEY_OBJECTS	Instance method	Public	Method	Collect Foreign Key Objects	20100514
4	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20100514
5	EXPLODE_OBJECTS	Instance method	Public	Method	Explode Objects	20100514
6	FIND_WHERE_USED	Instance method	Public	Method	Where-Used List for Changed Objects	20100514
7	FREE_DATA	Instance method	Public	Method		20100514
8	GET_ACTUAL_MEMORY	Instance method	Public	Method		20100514
9	GET_DB_SELECTOR	Instance method	Protected	Method	Instantiate Database Selector	20100514
10	GET_FOREIGN_KEY_OBJECTS	Instance method	Public	Method	Find Foreign Key Objects	20100514
11	GET_OPTIONS	Instance method	Public	Method	Output Settings	20100514
12	GET_STATISTIC	Instance method	Public	Method	Output Statistical Information	20100514
13	LOG_ACTUAL_MEMORY	Instance method	Public	Method		20100514
14	LOG_STATISTIC	Instance method	Protected	Method	Log Statistical Information	20100514
15	POST_EXPLOSION_PROCESSING	Instance method	Protected	Method	Method Call After Each Explosion	20100514
16	SET_OPTIONS	Instance method	Public	Method	Change Settings	20100514
17	SET_UI_OPTIONS	Instance method	Protected	Method	Change UI Settings	20100514
18	UPDATE_EXPLOSION_STATUS	Instance method	Protected	Method	Refresh Explosion Status	20100514
19	UPDATE_UTILITIES	Instance method	Public	Method		20100514
20	WRITE_EXPLOSION_INFORMATION	Instance method	Protected	Method	Output Information on Last Explosion	20100514

Events

Class CL_FOX3_EXPLODER has no event.

Types

Class CL_FOX3_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	CS_UI_OPTIONS	Call by reference	☑	Type reference (TYPE)	FOX3_UI_OPTIONS_S		Interface Options	20100514
2	Importing	IS_TOP_OBJECT	Call by reference	☑	Type reference (TYPE)	FOX3_OBJECT_KEY_S		Generic Object Key for Factory	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_DIRECTION	Call by reference	☑	Type reference (TYPE)	FOX3_EXPL_DIRECTION		Direction of Explosion	20100514
7	Importing	IV_FIRST_SCREEN	Call by reference	☑	Type reference (TYPE)	SYUCOMM		Screens, Function Code Triggered by PAI	20100514
8	Importing	IV_SOURCE	Call by reference	☐	Type reference (TYPE)	FOX3_DATA_SOURCE		Single-Character Indicator	20100514

#	Exception	Resumable	Description	Created on
1	ANALYSIS_ERROR	☐	Error in Analysis	20100514
2	INVALID_DIRECTION	☐	Invalid Direction of Explosion	20100514
3	INVALID_REFERENCE	☐	Invalid Object Reference	20100514
4	OBJECT_IS_NOT_TOP	☐	Object Is Not a Top-Level Object	20100514

Method CLASS_CONSTRUCTOR Signature

Method CLASS_CONSTRUCTOR on class CL_FOX3_EXPLODER has no parameter.
Method CLASS_CONSTRUCTOR on class CL_FOX3_EXPLODER has no exception.

Method COLLECT_FOREIGN_KEY_OBJECTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_PARENT_OBJECTS	Call by reference	☐	Type reference (TYPE)	FOX3_PARENT_OBJECTS_KEY_T		Objects and Their Successors	20100514

Method COLLECT_FOREIGN_KEY_OBJECTS on class CL_FOX3_EXPLODER has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	II_PERSISTENCE_CONTROLLER	Call by reference	☑	Object reference (TYPE REF TO)	IF_FOX3_PERSISTENCE_CONTROLLER		Control of Persistence	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	IV_PROFILE	Call by reference	☐	Type reference (TYPE)	FOX0_PROFILE		FOX Explosion Profile	20100514
5	Importing	IV_REQUEST_ID	Call by reference	☑	Type reference (TYPE)	FOX3_REQUEST_ID		FOX Request ID	20100514
6	Importing	IV_START_OF_EXPLOSION	Call by reference	☑	Type reference (TYPE)	FOX3_START_OF_EXPLOSION		Start Time for Explosion	20100514
7	Importing	IV_STRUCT_ID	Call by reference	☑	Type reference (TYPE)	FOX3_STRUCT_DB_ID		Database ID of a FOX Cache	20100514

#	Exception	Resumable	Description	Created on
1	PROFILE_ERROR	☐	No Usable Profile Found	20100514

Method EXPLODE_OBJECTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_OBJECT_STRUCTURE	Call by reference	☐	Type reference (TYPE)	FOX3_OBJECT_STRUCTURE_T		Objects with Structure Explosion	20100514
2	Changing	CV_TOTAL_OBJECTS	Call by reference	☑	Type reference (TYPE)	I		All Objects Found	20100514
3	Exporting	ET_PSEUDO_EXPLOSION	Call by reference	☐	Type reference (TYPE)	FOX3_PSEUDO_EXPLOSION_T		Conversion of Derived Explosion	20100514
4	Exporting	EV_FIRST_ERROR	Call by reference	☐	Type reference (TYPE)	SY-INDEX		Index Where Error Occurred	20100514
5	Importing	IV_CHECK_TOP_OBJECT	Call by reference	☐	Type reference (TYPE)	FLAG_X	'X'	Indicator	20100514
6	Importing	IV_DIRECTION	Call by reference	☐	Type reference (TYPE)	FOX3_EXPL_DIRECTION	CL_FOX3_CONSTANTS=>GC_TOP_DOWN	Direction of Explosion	20100514
7	Importing	IV_DO_NOT_EXPLODE	Call by reference	☑	Type reference (TYPE)	FLAG_X		Indicator	20100514
8	Importing	IV_ONE_LEVEL	Call by reference	☑	Type reference (TYPE)	FLAG_X		Indicator	20100514

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

Method FIND_WHERE_USED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CV_TOTAL_OBJECTS	Call by reference	☐	Type reference (TYPE)	I		All Objects Found	20100514
2	Exporting	ET_TOP_OBJECTS	Call by reference	☐	Type reference (TYPE)	FOX3_OBJECT_KEY_T		Generic Object Key for Factory	20100514
3	Exporting	EV_EXPLOSION_STATUS	Call by reference	☐	Type reference (TYPE)	FOX3_EXPLOSION_STATUS		Explosion Status	20100514
4	Importing	IT_CHANGED_OBJECT_STATES	Call by reference	☐	Type reference (TYPE)	FOX3_OBJECT_STATE_T		Object State in FOX2	20100514

#	Exception	Resumable	Description	Created on
1	DIRECTION_NOT_SUPPORTED	☐	Direction of Explosion Is Not Supported	20100514

Method FREE_DATA Signature

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

Method GET_ACTUAL_MEMORY Signature

Method GET_ACTUAL_MEMORY on class CL_FOX3_EXPLODER has no parameter.
Method GET_ACTUAL_MEMORY on class CL_FOX3_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_FOREIGN_KEY_OBJECTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_PARENT_OBJECTS	Call by reference	☐	Type reference (TYPE)	FOX3_PARENT_OBJECTS_KEY_T		Objects and Their Successors	20100514
2	Changing	CV_TOTAL_OBJECTS	Call by reference	☐	Type reference (TYPE)	I			20100514

Method GET_FOREIGN_KEY_OBJECTS on class CL_FOX3_EXPLODER has no exception.

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_EXPLODER has no exception.

Method GET_STATISTIC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_CACHE_STAT_BOTTOM_UP	Call by reference	☐	Type reference (TYPE)	FOX3_CACHE_STATISTIC_T		Cache Statistics	20100514
2	Exporting	ET_CACHE_STAT_TOP_DOWN	Call by reference	☐	Type reference (TYPE)	FOX3_CACHE_STATISTIC_T		Cache Statistics	20100514
3	Exporting	ET_CTRL_STAT_BOTTOM_UP	Call by reference	☐	Type reference (TYPE)	FOX3_CONTROLLER_STATISTIC_T		Controller Statistics	20100514
4	Exporting	ET_CTRL_STAT_TOP_DOWN	Call by reference	☐	Type reference (TYPE)	FOX3_CONTROLLER_STATISTIC_T		Controller Statistics	20100514
5	Exporting	ET_FACTORY_STATISTIC	Call by reference	☐	Type reference (TYPE)	FOX3_FACTORY_STATISTIC_T		Factory Statistics	20100514
6	Exporting	ET_TIMING	Call by reference	☐	Type reference (TYPE)	PTU_TIMING_T		Object-Specific Time Information	20100514

Method GET_STATISTIC on class CL_FOX3_EXPLODER has no exception.

Method LOG_ACTUAL_MEMORY Signature

Method LOG_ACTUAL_MEMORY on class CL_FOX3_EXPLODER has no parameter.
Method LOG_ACTUAL_MEMORY on class CL_FOX3_EXPLODER has no exception.

Method LOG_STATISTIC Signature

Method LOG_STATISTIC on class CL_FOX3_EXPLODER has no parameter.
Method LOG_STATISTIC on class CL_FOX3_EXPLODER has no exception.

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
2	Importing	IV_STRUCTURE	Call by reference	☐	Type reference (TYPE)	FOX3_STRUCTURE		Explosion Structure	20100514

Method POST_EXPLOSION_PROCESSING on class CL_FOX3_EXPLODER has no exception.

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_EXPLODER has no exception.

Method SET_UI_OPTIONS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_UI_OPTIONS	Call by reference	☐	Type reference (TYPE)	FOX3_UI_OPTIONS_S		Interface Options	20100514

Method SET_UI_OPTIONS on class CL_FOX3_EXPLODER has no exception.

Method UPDATE_EXPLOSION_STATUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CV_ACTUAL_STATUS	Call by reference	☐	Type reference (TYPE)	FOX3_EXPLOSION_STATUS		Explosion Status	20100514
2	Importing	IV_NEW_STATUS	Call by reference	☐	Type reference (TYPE)	FOX3_EXPLOSION_STATUS		Explosion Status	20100514

Method UPDATE_EXPLOSION_STATUS on class CL_FOX3_EXPLODER has no exception.

Method UPDATE_UTILITIES Signature

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

Method WRITE_EXPLOSION_INFORMATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_STRUCTURE	Call by reference	☐	Type reference (TYPE)	FOX3_STRUCTURE		Explosion Structure	20100514

Method WRITE_EXPLOSION_INFORMATION on class CL_FOX3_EXPLODER has no exception.

History

Last changed by/on	SAP	20110908
SAP Release Created in	640