SAP ABAP Class CL_FOX3_MULTILEVEL_STRUCTURE (Multilevel Object Structure)

Hierarchy

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

Properties

Class	CL_FOX3_MULTILEVEL_STRUCTURE
Short Description	Multilevel Object Structure
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	CL_FOX3_CONSTANTS	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
2	CL_PTU_CONSTANTS	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)

Interfaces

Class CL_FOX3_MULTILEVEL_STRUCTURE has no interface implemented.

Friends

#	Friend	Modeled only	Created on	Description
1	CL_FOX3_CONTROLLER	☐	20100514	Control Unit for the Explosion
2	CL_FOX3_EXPLODER	☐	20100514	Main Class for Simple Explosions

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GO_CACHE	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_FOX3_STRUCTURED_CACHE		Cache for Structure Explosion	20100514
2	GS_TOP_OBJECT	Instance attribute	Private	☐	Type reference (TYPE)	FOX3_LINKED_CACHE_OBJECT_S		Dependent Object	20100514
3	GV_DIRECTION	Instance attribute	Private	☐	Type reference (TYPE)	FOX3_EXPL_DIRECTION		Direction of Explosion	20100514
4	GV_EXPLOSION_STATUS	Instance attribute	Private	☐	Type reference (TYPE)	FOX3_EXPLOSION_STATUS		Explosion Status	20100514
5	GV_IGNORE_UNCHANGED	Instance attribute	Private	☐	Type reference (TYPE)	FOX3_IGNORE_UNCHANGED		Ignore Unchanged Objects	20100514
6	GV_NOT_EXPLODED	Instance attribute	Private	☐	Type reference (TYPE)	FOX3_NOT_EXPLODED		Not Exploded	20100514
7	GV_REQUEST_ID	Instance attribute	Public	☑	Type reference (TYPE)	FOX3_REQUEST_ID		FOX Request ID	20100514
8	GV_STRUCT_ID	Instance attribute	Public	☑	Type reference (TYPE)	FOX3_STRUCT_DB_ID		Database ID of a FOX Cache	20100514

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CLEAR_CALL_CONTEXT_BUFFER	Instance method	Public	Method	Reset Buffer for Call Context	20100514
2	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20100514
3	GET_CACHE	Instance method	Public	Method	Output Cache	20100514
4	GET_EXPLOSION_STATUS	Instance method	Public	Method	Output Status	20100514
5	GET_TOP_OBJECT	Instance method	Public	Method	Supplies Top Object in the Structure	20100514
6	ITERATE	Instance method	Public	Method	Iteration Method Using Object Tree	20100514
7	RETURN_ALL_OBJECTS_TO_PARENT	Instance method	Public	Method	Find All Dependent Objects for an Object	20100514
8	RETURN_REFERENCE_TO_STRUCTURE	Instance method	Public	Method	Return Reference to the Structure	20100514
9	RETURN_STRUCTURE_INSTANCES	Instance method	Public	Method	Return Structure Exploded with Object Instances	20100514
10	SET_EXPLOSION_STATUS	Instance method	Private	Method	Set Status	20100514

Events

Class CL_FOX3_MULTILEVEL_STRUCTURE has no event.

Types

Class CL_FOX3_MULTILEVEL_STRUCTURE has no local type.

Method Signatures

Method CLEAR_CALL_CONTEXT_BUFFER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ALL_CONTEXTS	Call by reference	☑	Type reference (TYPE)	FLAG_X		Indicator	20100514
2	Importing	IV_CALL_CONTEXT	Call by reference	☑	Type reference (TYPE)	FOX3_CALL_CONTEXT		Call Context	20100514

Method CLEAR_CALL_CONTEXT_BUFFER on class CL_FOX3_MULTILEVEL_STRUCTURE has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_CACHE	Call by reference	☐	Object reference (TYPE REF TO)	CL_FOX3_STRUCTURED_CACHE		Cache for Structure Explosion	20100514
2	Importing	IS_OBJECT	Call by reference	☐	Type reference (TYPE)	FOX3_LINKED_CACHE_OBJECT_S		Dependent Object (Type of Relationship, Instance)	20100514
3	Importing	IV_DIRECTION	Call by reference	☐	Type reference (TYPE)	FOX3_EXPL_DIRECTION	CL_FOX3_CONSTANTS=>GC_TOP_DOWN	Direction of Explosion	20100514
4	Importing	IV_EXPLOSION_STATUS	Call by reference	☐	Type reference (TYPE)	FOX3_EXPLOSION_STATUS	CL_FOX3_CONSTANTS=>GC_EXPL_STAT_SUCCESSFUL	Explosion Status	20100514
5	Importing	IV_IGNORE_UNCHANGED	Call by reference	☑	Type reference (TYPE)	FOX3_IGNORE_UNCHANGED		Ignore Unchanged Objects	20100514
6	Importing	IV_NOT_EXPLODED	Call by reference	☑	Type reference (TYPE)	FOX3_NOT_EXPLODED		Not Exploded	20100514

Method CONSTRUCTOR on class CL_FOX3_MULTILEVEL_STRUCTURE has no exception.

Method GET_CACHE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EO_CACHE	Call by reference	☐	Object reference (TYPE REF TO)	CL_FOX3_STRUCTURED_CACHE		Cache for the Structure Explosion	20100514

Method GET_CACHE on class CL_FOX3_MULTILEVEL_STRUCTURE has no exception.

Method GET_EXPLOSION_STATUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_EXPLOSION_STATUS	Call by reference	☐	Type reference (TYPE)	FOX3_EXPLOSION_STATUS		Explosion Status	20100514

Method GET_EXPLOSION_STATUS on class CL_FOX3_MULTILEVEL_STRUCTURE has no exception.

Method GET_TOP_OBJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_TOP_OBJECT	Call by reference	☐	Type reference (TYPE)	FOX3_LINKED_OBJECT_S		Object and Link Color for FOX Caller	20100514
2	Exporting	EV_DIRECTION	Call by reference	☐	Type reference (TYPE)	FOX3_EXPL_DIRECTION		Direction of Explosion	20100514
3	Exporting	EV_IGNORE_UNCHANGED	Call by reference	☐	Type reference (TYPE)	FOX3_IGNORE_UNCHANGED		Ignore Unchanged Objects	20100514
4	Exporting	EV_NOT_EXPLODED	Call by reference	☐	Type reference (TYPE)	FOX3_NOT_EXPLODED		Not Exploded	20100514

Method GET_TOP_OBJECT on class CL_FOX3_MULTILEVEL_STRUCTURE has no exception.

Method ITERATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	II_VISITOR	Call by reference	☐	Object reference (TYPE REF TO)	IF_FOX3_OBJECT_VISITOR		Visitor Interface for a FOX Object	20100514
2	Importing	IV_CALL_CONTEXT	Call by reference	☑	Type reference (TYPE)	FOX3_CALL_CONTEXT		Call Context	20100514
3	Importing	IV_DONT_COLLECT_UNCHANGED	Call by reference	☑	Type reference (TYPE)	FOX3_DONT_COLLECT_UNCHANGED		Do Not Collect Unchanged Objects	20100514
4	Importing	IV_RESULT_MODE	Call by reference	☐	Type reference (TYPE)	FOX3_RESULT_MODE	CL_FOX3_CONSTANTS=>GC_RESULT_ONCE_WITH_STRUCTURE	Return of Explosion Results (See CL_FOX_CONSTANTS)	20100514
5	Importing	IV_SORTED	Call by reference	☐	Type reference (TYPE)	FOX3_SORTED_BY_KEYS		Objects Sorted by Keys	20100514
6	Importing	IV_USE_FILTER	Call by reference	☐	Type reference (TYPE)	FOX3_USE_FILTER	'X'	Use Filter in the Explosion Profile	20100514

#	Exception	Resumable	Description	Created on
1	INVALID_PARAMETERS	☐	Invalid Parameterization	20100514
2	NO_VISITOR	☐	No Visitor Interface Exists	20100514
3	VISIT_INTERUPTED	☐	Visitor Iteration Was Interrupted	20100514

Method RETURN_ALL_OBJECTS_TO_PARENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_OBJECTS	Call by reference	☐	Type reference (TYPE)	FOX3_LINKED_OBJECT_NOSORT_T		Object and Link Color for FOX Caller	20100514
2	Importing	IS_PARENT	Call by reference	☐	Type reference (TYPE)	FOX3_LINKED_OBJECT_S		Object and Link Color for FOX Caller	20100514
3	Importing	IV_CALL_CONTEXT	Call by reference	☑	Type reference (TYPE)	FOX3_CALL_CONTEXT		Call Context	20100514
4	Importing	IV_RESULT_MODE	Call by reference	☐	Type reference (TYPE)	FOX3_RESULT_MODE	CL_FOX3_CONSTANTS=>GC_RESULT_ONCE_WITH_STRUCTURE	Return of Explosion Results (See CL_FOX_CONSTANTS)	20100514
5	Importing	IV_SORTED	Call by reference	☐	Type reference (TYPE)	FOX3_SORTED_BY_KEYS		Objects Sorted by Keys	20100514
6	Importing	IV_USE_FILTER	Call by reference	☐	Type reference (TYPE)	FOX3_USE_FILTER	'X'	Use Filter in the Explosion Profile	20100514

#	Exception	Resumable	Description	Created on
1	INVALID_PARAMETERS	☐	Invalid Parameterization	20100514
2	NO_PARENT	☐	No Objects Entered	20100514

Method RETURN_REFERENCE_TO_STRUCTURE Signature

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

Method RETURN_REFERENCE_TO_STRUCTURE on class CL_FOX3_MULTILEVEL_STRUCTURE has no exception.

Method RETURN_STRUCTURE_INSTANCES 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		Return Hierarchy As Table of Instances	20100514
2	Importing	IV_CALL_CONTEXT	Call by reference	☑	Type reference (TYPE)	FOX3_CALL_CONTEXT		Call Context	20100514
3	Importing	IV_DONT_COLLECT_UNCHANGED	Call by reference	☑	Type reference (TYPE)	FOX3_DONT_COLLECT_UNCHANGED		Do Not Collect Unchanged Objects	20100514
4	Importing	IV_RESULT_MODE	Call by reference	☐	Type reference (TYPE)	FOX3_RESULT_MODE	CL_FOX3_CONSTANTS=>GC_RESULT_ONCE_WITH_STRUCTURE	Return of Explosion Results (See CL_FOX_CONSTANTS)	20100514
5	Importing	IV_SORTED	Call by reference	☐	Type reference (TYPE)	FOX3_SORTED_BY_KEYS		Objects Sorted by Keys	20100514
6	Importing	IV_USE_FILTER	Call by reference	☐	Type reference (TYPE)	FOX3_USE_FILTER	'X'	Use Filter in the Explosion Profile	20100514

#	Exception	Resumable	Description	Created on
1	INVALID_PARAMETERS	☐	Invalid Parameterization	20100514

Method SET_EXPLOSION_STATUS Signature

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

Method SET_EXPLOSION_STATUS on class CL_FOX3_MULTILEVEL_STRUCTURE has no exception.

History

Last changed by/on	SAP	20110908
SAP Release Created in