SAP ABAP Class CL_FOX_CONTROLLER (Control Unit for the Explosion)

Hierarchy

☛ EA-APPL (Software Component) SAP Enterprise Extension PLM, SCM, Financials
   ⤷ LO-PDM (Application Component) Product Data Management
     ⤷ PLM_FOX (Package) Framework for hierarchy explosion

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_FOX_MSG_PARAMETER	Parameters for FOX Messages	20020320
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_FOX_OBJECT_EXPLODER	Interface for the controller of the explosion	20010403
3	Interface implementation (CLASS c. INTERFACES i_ref)	IF_FOX_OBJECT_STACK	Interface for object stack	20001216
4	Interface implementation (CLASS c. INTERFACES i_ref)	IF_FOX_PARAMETERS	Parameter for Explosion	20010327
5	Interface implementation (CLASS c. INTERFACES i_ref)	IF_FOX_PERSISTENCE_CONTROLLER	Control of Persistence	20010327

Properties

Class	CL_FOX_CONTROLLER
Short Description	Control Unit for the Explosion
Super Class
Instantiability of a Class	0	Private
Final	☑

General Data

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

Forward declarations

#	Type group / Object type	Type	Type Description
1	CL_FOX_CONSTANTS	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
2	CL_FOX_LINK_TYPES	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
3	CL_PTU_CONSTANTS	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_FOX_MSG_PARAMETER	☐	☐	Parameters for FOX Messages	20020320
2	IF_FOX_OBJECT_EXPLODER	☐	☐	Interface for the controller of the explosion	20010403
3	IF_FOX_OBJECT_STACK	☐	☐	Interface for object stack	20001216
4	IF_FOX_PARAMETERS	☐	☐	Parameter for Explosion	20010327
5	IF_FOX_PERSISTENCE_CONTROLLER	☐	☐	Control of Persistence	20010327

Friends

Class CL_FOX_CONTROLLER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_TAG	Constant	Private	☐	Type reference (TYPE)	PTU_TAG	CL_FOX_CONSTANTS=>GC_TAG_CONTROLLER	Indicator	20000811
2	GO_CACHE	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_FOX_STRUCTURED_CACHE		Cache for Structure Explosion	20000804
3	GO_FACTORY	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_FOX_STRUCT_OBJECT_FACTORY		Factory for Instances of Structured Objects	20010702
4	GS_MSG_PARAMETERS	Instance attribute	Private	☐	Attribute reference (LIKE)				20020320
5	GS_UTIL_IF	Instance attribute	Private	☐	Type reference (TYPE)	PTU_UTIL_IF_S		Structure with Utility Interface	20000814
6	GT_FACTORY	Static Attribute	Private	☐	See coding			Instance Management	20010709
7	GT_STACK	Instance attribute	Private	☐	Type reference (TYPE)	FOX_LINKED_CACHE_OBJ_NOSORT_T		Table of Dependent Objects (Not Sorted)	20010405
8	GT_STATISTIC	Instance attribute	Private	☐	See coding			Statistics Table	20010709
9	GV_CURRENT_EXPLOSION	Instance attribute	Private	☐	Type reference (TYPE)	I		Current Explosion	20001122
10	GV_CURRENT_LEVEL	Instance attribute	Private	☐	Type reference (TYPE)	I		Current Explosion Level	20010220
11	GV_DELETE_FAILED	Instance attribute	Public	☐	Attribute reference (LIKE)				20010713
12	GV_FREED	Instance attribute	Public	☑	Type reference (TYPE)	FOX_FREED		Instance Is Marked As Deleted	20010704
13	GV_READ_FAILED	Instance attribute	Public	☐	Attribute reference (LIKE)				20010403
14	GV_SAVED	Instance attribute	Public	☑	Type reference (TYPE)	FLAG_X		Data Already Saved	20010403
15	GV_STACK_SIZE	Instance attribute	Private	☐	Type reference (TYPE)	I		Size of Stack	20010405
16	GV_STRUCT_ID	Instance attribute	Public	☑	Type reference (TYPE)	FOX_STRUCT_DB_ID		ID of Database Storage from a Cache	20010327
17	GV_TOTAL_EXPLOSIONS	Instance attribute	Private	☐	Type reference (TYPE)	I		Number of Explosions (for Progress Determination)	20001122
18	GV_TOTAL_OBJECTS	Instance attribute	Private	☐	Type reference (TYPE)	I		Number of Found Objects	20001122
19	GV_WRITE_FAILED	Instance attribute	Public	☐	Attribute reference (LIKE)				20010403
20	SV_MSG_DUMMY	Static Attribute	Private	☐	Type reference (TYPE)	CHAR1		Single-Character Indicator	20020323
21	SV_MSG_LINK_TYPE_EXT	Static Attribute	Private	☐	Type reference (TYPE)	FOX_LINK_TYPE_EXT		External Format of Object Relationship	20020323
22	SV_MSG_OBJ_KEY_EXT	Static Attribute	Private	☐	Type reference (TYPE)	FOX_OBJ_KEY_EXT		External Object Key (Such As Material or BOM)	20020323
23	SV_MSG_OBJ_TYPE_EXT	Static Attribute	Private	☐	Type reference (TYPE)	FOX_OBJ_TYPE_EXT		External Format of Object Type	20020323

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	20000721
2	DELETE_CONTROLLER	Static method	Public	Method	Deletes Controller and Releases All Data	20010704
3	DELETE_CONTROLLER_WITH_ID	Static method	Public	Method	Deletes Controller and Releases All Data	20010704
4	DELETE_REFERENCE	Static method	Public	Method	Delete Reference	20010703
5	EXPLODE_OBJECT	Instance method	Public	Method	Explode Given Object	20000721
6	EXPLODE_ONE_LEVEL	Instance method	Private	Method	Explode the Next Level Recursively	20010406
7	FLOB_WHERE_USED	Static method	Public	Method	Where is a FLOB used?	20010906
8	FREE_DATA	Instance method	Private	Method	Release Data	20010704
9	GET_CONTROLLER_INSTANCE	Static method	Public	Method	Return Instance for Explosion	20010327
10	GET_OBJECT_STACK	Instance method	Public	Method		20001216
11	HANDLE_DELETE_FAILED	Instance method	Private	Method	Error Handling: Error When Deleting	20010713
12	HANDLE_READ_FAILED	Instance method	Private	Method	Error Handling: Error During Import	20010403
13	HANDLE_WRITE_FAILED	Instance method	Private	Method	Error Handling: Error While Writing	20010403
14	IS_FLOB_USED	Static method	Public	Method	Is a FLOB Used?	20010906
15	READ_DATA	Instance method	Private	Method	Import FOX Data (FLOB)	20010703
16	RETURN_OBJECT_EXPLOSION	Instance method	Private	Method	Return MLS for Completed Explosions	20010327
17	RETURN_STRUCTURE_TO_REFERENCE	Static method	Public	Method	Return Structure for a Reference	20010327
18	RETURN_STRUCT_ID_TO_VIRTUAL	Static method	Public	Method	Return Structure for an External Explosion	20010402
19	SET_MSG_PARAMETERS	Instance method	Public	Method		20020320
20	SET_MSG_PARAMETERS_DEFAULTS	Static method	Private	Method	Set Default Value for Message Parameters	20020320
21	TRY_CONTROLLER_INSTANCE	Static method	Public	Method	Checks Whether a Controller Exists	20010814
22	WRITE_STATISTIC	Instance method	Public	Method	Update statistics	20000817

Events

Class CL_FOX_CONTROLLER has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TS_FACTORY	Private	See coding		Instance Management	20010709
2	TS_STATISTIC	Private	See coding		Statistics Table	20010709

Method Signatures

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_FOX_PARAMETERS		Paramter für die Auflösung	20000804
2	Importing	IS_MSG_PARAMETERS	Call by reference	☐	Type reference (TYPE)	FOX_MSG_PARAMETER_S		Parameter für FOX-Messages	20020320
3	Importing	IS_UTIL_IF	Call by reference	☑	Type reference (TYPE)	PTU_UTIL_IF_S		Struktur mit Utility-Interfaces	20000814
4	Importing	IT_CLASSES	Call by reference	☑	Type reference (TYPE)	FOX_STRUCTURED_CLASS_T		Tabelle der Implementierungen für cl_fox_structured_object	20000804
5	Importing	IV_STRUCT_ID	Call by reference	☑	Type reference (TYPE)	FOX_STRUCT_DB_ID		ID der Datenbankablage von einem Cache	20010327
6	Importing	IV_TOTAL_OBJECTS	Call by reference	☐	Type reference (TYPE)	I	1	Anzahl der erwarteten Explode-Aufrufe	20001122

Method CONSTRUCTOR on class CL_FOX_CONTROLLER has no exception.

Method DELETE_CONTROLLER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_CONTROLLER	Call by reference	☐	Object reference (TYPE REF TO)	CL_FOX_CONTROLLER		Steuereinheit für die Auflösung	20010704

#	Exception	Resumable	Description	Created on
1	UNKNOWN_INSTANCE	☐	unbekannte Instanz	20010704

Method DELETE_CONTROLLER_WITH_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_STRUCT_ID	Call by reference	☐	Type reference (TYPE)	FOX_STRUCT_DB_ID		Datenbank-ID eines FOX-Cache	20010704

#	Exception	Resumable	Description	Created on
1	UNKNOWN_ID	☐	unbekannte Instanz	20010704

Method DELETE_REFERENCE 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_FOX_CONTROLLER		Steuereinheit für die Auflösung	20010716
2	Importing	II_PARAMETERS	Call by reference	☑	Object reference (TYPE REF TO)	IF_FOX_PARAMETERS		Paramter für die Auflösung	20010716
3	Importing	IS_MSG_PARAMETERS	Value transfer	☑	Type reference (TYPE)	FOX_MSG_PARAMETER_S		Parameter für FOX-Messages	20020320
4	Importing	IS_UTIL_IF	Call by reference	☑	Type reference (TYPE)	PTU_UTIL_IF_S		Struktur mit Utility-Interfaces	20010703
5	Importing	IT_CLASSES	Call by reference	☑	Type reference (TYPE)	FOX_STRUCTURED_CLASS_T		Tabelle der Implementierungen für cl_fox_structured_object	20010716
6	Importing	IV_STRUCT_ID	Call by reference	☐	Type reference (TYPE)	FOX_STRUCT_DB_ID		Referenz auf Persistente Struktur	20010703

#	Exception	Resumable	Description	Created on
1	REFERENCE_IS_USED	☐	Referenz wird noch verwendet	20010831
2	REFERENCE_NOT_VALID	☐	Referez kann nicht aufgelöst werden	20010703

Method EXPLODE_OBJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EO_STRUCTURE	Call by reference	☐	Object reference (TYPE REF TO)	CL_FOX_MULTILEVEL_STRUCTURE		Mehrstufige Objektstruktur	20000804
2	Importing	IS_OBJECT_KEY	Call by reference	☐	Type reference (TYPE)	FOX_OBJECT_KEY_S		Generischer Objektkey für Factory	20000804
3	Importing	IV_LINK_TYPE	Call by reference	☑	Type reference (TYPE)	FOX_LINK_TYPE		Typ der Beziehung zwischen Objekten	20000824

#	Exception	Resumable	Description	Created on
1	ALREADY_SAVED	☐	Daten wurden schon gesichert	20010403
2	OBJECT_NOT_EXPLODED	☐	Objekt wurde nicht aufgelöst	20000901

Method EXPLODE_ONE_LEVEL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_OBJECT	Call by reference	☐	Type reference (TYPE)	FOX_LINKED_CACHE_OBJECT_S		Abhängiges Objekt	20010406
2	Importing	IV_MAX_PROGRESS	Call by reference	☑	Type reference (TYPE)	I		Maximaler Fortschritt in dieser Auflösung	20010406
3	Importing	IV_MIN_PROGRESS	Call by reference	☑	Type reference (TYPE)	I		Schon erledigter Fortschritt	20010406

Method EXPLODE_ONE_LEVEL on class CL_FOX_CONTROLLER has no exception.

Method FLOB_WHERE_USED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_BOR_OBJECTS	Call by reference	☐	Type reference (TYPE)	TRL_BORID		SREL: Tabelle von BOR Objekten	20010906
2	Importing	IV_STRUCT_ID	Call by reference	☐	Type reference (TYPE)	FOX_STRUCT_DB_ID		Datenbank-ID eines FOX-Cache	20010906

Method FLOB_WHERE_USED on class CL_FOX_CONTROLLER has no exception.

Method FREE_DATA Signature

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

Method GET_CONTROLLER_INSTANCE 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_FOX_CONTROLLER		Steuereinheit für die Auflösung	20010327
2	Importing	II_PARAMETERS	Call by reference	☐	Object reference (TYPE REF TO)	IF_FOX_PARAMETERS		Paramter für die Auflösung	20010327
3	Importing	IS_MSG_PARAMETERS	Value transfer	☑	Type reference (TYPE)	FOX_MSG_PARAMETER_S		Parameter für FOX-Messages	20020320
4	Importing	IS_UTIL_IF	Call by reference	☑	Type reference (TYPE)	PTU_UTIL_IF_S		Struktur mit Utility-Interfaces	20010327
5	Importing	IT_CLASSES	Call by reference	☐	Type reference (TYPE)	FOX_STRUCTURED_CLASS_T		Tabelle der Implementierungen für cl_fox_structured_object	20010327
6	Importing	IV_TOTAL_OBJECTS	Call by reference	☐	Type reference (TYPE)	I	1	Anzahl der erwarteten Explode-Aufrufe	20010327

Method GET_CONTROLLER_INSTANCE on class CL_FOX_CONTROLLER has no exception.

Method GET_OBJECT_STACK Signature

Method GET_OBJECT_STACK on class CL_FOX_CONTROLLER has no parameter.
Method GET_OBJECT_STACK on class CL_FOX_CONTROLLER has no exception.

Method HANDLE_DELETE_FAILED Signature

Method HANDLE_DELETE_FAILED on class CL_FOX_CONTROLLER has no parameter.
Method HANDLE_DELETE_FAILED on class CL_FOX_CONTROLLER has no exception.

Method HANDLE_READ_FAILED Signature

Method HANDLE_READ_FAILED on class CL_FOX_CONTROLLER has no parameter.
Method HANDLE_READ_FAILED on class CL_FOX_CONTROLLER has no exception.

Method HANDLE_WRITE_FAILED Signature

Method HANDLE_WRITE_FAILED on class CL_FOX_CONTROLLER has no parameter.
Method HANDLE_WRITE_FAILED on class CL_FOX_CONTROLLER has no exception.

Method IS_FLOB_USED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_USED	Call by reference	☐	Type reference (TYPE)	FLAG_X		Flag	20010906
2	Importing	IV_STRUCT_ID	Call by reference	☐	Type reference (TYPE)	FOX_STRUCT_DB_ID		Datenbank-ID eines FOX-Cache	20010906

Method IS_FLOB_USED on class CL_FOX_CONTROLLER has no exception.

Method READ_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	II_VIRTUAL_EXPLOSION	Call by reference	☑	Object reference (TYPE REF TO)	IF_FOX_VIRTUAL_STRUCT		Struktur von aussen vorgeben	20010703

#	Exception	Resumable	Description	Created on
1	READ_FAILED	☐	Fehler beim Einlesen	20010703
2	WRONG_CALL	☐	falscher Aufruf	20010716

Method RETURN_OBJECT_EXPLOSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EO_STRUCTURE	Call by reference	☐	Object reference (TYPE REF TO)	CL_FOX_MULTILEVEL_STRUCTURE		Mehrstufige Objektstruktur	20010327
2	Importing	IV_LINK_TYPE	Call by reference	☐	Type reference (TYPE)	FOX_LINK_TYPE		Typ der Beziehung zwischen Objekten	20010402
3	Importing	IV_OBJECT_ID	Call by reference	☐	Type reference (TYPE)	FOX_OBJECT_DB_ID		ID vom Objekt in der Datenbankablage	20010327

#	Exception	Resumable	Description	Created on
1	REFERENCE_NOT_VALID	☐	Referez kann nicht aufgelöst werden	20010327

Method RETURN_STRUCTURE_TO_REFERENCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EO_STRUCTURE	Call by reference	☐	Object reference (TYPE REF TO)	CL_FOX_MULTILEVEL_STRUCTURE		Mehrstufige Objektstruktur	20010327
2	Importing	II_PARAMETERS	Call by reference	☑	Object reference (TYPE REF TO)	IF_FOX_PARAMETERS		Paramter für die Auflösung	20010716
3	Importing	IS_MSG_PARAMETERS	Value transfer	☑	Type reference (TYPE)	FOX_MSG_PARAMETER_S		Parameter für FOX-Messages	20020320
4	Importing	IS_REFERENCE	Call by reference	☐	Type reference (TYPE)	FOX_PERSISTENT_ENTRY_S		Referenz auf Persistente Struktur	20010327
5	Importing	IS_UTIL_IF	Call by reference	☑	Type reference (TYPE)	PTU_UTIL_IF_S		Struktur mit Utility-Interfaces	20010327
6	Importing	IT_CLASSES	Call by reference	☐	Type reference (TYPE)	FOX_STRUCTURED_CLASS_T		Tabelle der Implementierungen für cl_fox_structured_object	20010327

#	Exception	Resumable	Description	Created on
1	REFERENCE_NOT_VALID	☐	Referez kann nicht aufgelöst werden	20010327
2	WRONG_CALL	☐	falscher Aufruf	20010716

Method RETURN_STRUCT_ID_TO_VIRTUAL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_STRUCT_ID	Call by reference	☐	Type reference (TYPE)	FOX_STRUCT_DB_ID		ID der Datenbankablage von einem Cache	20010402
2	Importing	II_VIRTUAL_EXPLOSION	Call by reference	☐	Object reference (TYPE REF TO)	IF_FOX_VIRTUAL_STRUCT		Struktur von aussen vorgeben	20010402
3	Importing	IS_MSG_PARAMETERS	Value transfer	☑	Type reference (TYPE)	FOX_MSG_PARAMETER_S		Parameter für FOX-Messages	20020320
4	Importing	IS_UTIL_IF	Call by reference	☑	Type reference (TYPE)	PTU_UTIL_IF_S		Struktur mit Utility-Interfaces	20010402
5	Importing	IT_CLASSES	Call by reference	☐	Type reference (TYPE)	FOX_STRUCTURED_CLASS_T		Tabelle der Implementierungen für cl_fox_structured_object	20010402

#	Exception	Resumable	Description	Created on
1	REFERENCE_NOT_VALID	☐	Referenz kann nicht aufgelöst werden	20010402
2	WRONG_CALL	☐	falscher Aufruf	20010716

Method SET_MSG_PARAMETERS Signature

Method SET_MSG_PARAMETERS on class CL_FOX_CONTROLLER has no parameter.
Method SET_MSG_PARAMETERS on class CL_FOX_CONTROLLER has no exception.

Method SET_MSG_PARAMETERS_DEFAULTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_MSG_PARAMETERS	Call by reference	☐	Type reference (TYPE)	FOX_MSG_PARAMETER_S		Parameter für FOX-Messages	20020320

Method SET_MSG_PARAMETERS_DEFAULTS on class CL_FOX_CONTROLLER has no exception.

Method TRY_CONTROLLER_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_HAS_CONTROLLER	Call by reference	☐	Type reference (TYPE)	FLAG_X		Flag	20010814
2	Importing	IV_STRUCT_ID	Call by reference	☐	Type reference (TYPE)	FOX_STRUCT_DB_ID		Datenbank-ID eines FOX-Cache	20010814

Method TRY_CONTROLLER_INSTANCE on class CL_FOX_CONTROLLER has no exception.

Method WRITE_STATISTIC Signature

Method WRITE_STATISTIC on class CL_FOX_CONTROLLER has no parameter.
Method WRITE_STATISTIC on class CL_FOX_CONTROLLER has no exception.

History

Last changed by/on	SAP	20050219
SAP Release Created in	46C1