SAP ABAP Class CL_FOX3_REQUEST (FOX API Class for Processing Requests)

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_FOX3_MEMORY_AWARE_OBJECT	Read Memory Consumption	20100514
3	Interface implementation (CLASS c. INTERFACES i_ref)	IF_FOX3_PERSISTENCE_CONTROLLER	Control of Persistence	20100514
4	Interface implementation (CLASS c. INTERFACES i_ref)	IF_FOX3_PERSISTENCE_PARAMETERS	Control of Persistence	20100514
5	Interface implementation (CLASS c. INTERFACES i_ref)	IF_PTU_HAS_UTILITY_OBJECTS	Object Has Help Objects	20100514

Properties

Class	CL_FOX3_REQUEST
Short Description	FOX API Class for Processing Requests
Super Class
Instantiability of a Class	0	Private
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_FOX3_OBJECT_TYPES	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
3	CL_FOX3_PACKAGE	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
4	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_FOX3_FREEABLE_OBJECT	☐	☐	ObjeCt with Free_Data Method	20100514
2	IF_FOX3_MEMORY_AWARE_OBJECT	☐	☐	Read Memory Consumption	20100514
3	IF_FOX3_PERSISTENCE_CONTROLLER	☐	☐	Control of Persistence	20100514
4	IF_FOX3_PERSISTENCE_PARAMETERS	☐	☐	Control of Persistence	20100514
5	IF_PTU_HAS_UTILITY_OBJECTS	☐	☐	Object Has Help Objects	20100514

Friends

Class CL_FOX3_REQUEST has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_DUMMY_ID	Constant	Protected	☐	Type reference (TYPE)	FOX3_REQUEST_ID	CL_FOX3_CONSTANTS=>GC_REQUEST_ID_DUMMY	FOX Request ID	20100514
2	GC_EXPLODER_DB	Constant	Protected	☐	Type reference (TYPE)	FOX3_TABNAME	CL_FOX3_CONSTANTS=>GC_EXPLODER_DB	Table Name, 16 Characters	20100514
3	GC_NUMRANGE_REQUEST	Constant	Protected	☐	Type reference (TYPE)	NROBJ	'FOX3_REQ'	Name of Number Range Object	20100514
4	GC_OBJ_TYPE_REQUEST	Constant	Public	☐	Type reference (TYPE)	FOX3_OBJ_TYPE	CL_FOX3_OBJECT_TYPES=>GC_REQUEST	Object Type (Such As Material or BOM)	20100514
5	GC_REQUEST_DB	Constant	Protected	☐	Type reference (TYPE)	FOX3_TABNAME	CL_FOX3_CONSTANTS=>GC_REQUEST_DB	Table Name, 16 Characters	20100514
6	GC_TAG	Constant	Protected	☐	Type reference (TYPE)	PTU_TAG	CL_FOX3_CONSTANTS=>GC_TAG_REQUEST	Indicator	20100514
7	GI_MESSAGE	Instance attribute	Protected	☐	Attribute reference (LIKE)				20100514
8	GI_PERS_UPDATER	Instance attribute	Private	☐	Attribute reference (LIKE)				20100514
9	GO_MESSAGE	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_PTU_MESSAGE		Collect Messages	20100514
10	GO_PERS_UPDATER	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_FOX3_PERSISTENCE_UPDATER		Update Database	20100514
11	GS_DISPLAY_OPTIONS	Instance attribute	Protected	☐	Type reference (TYPE)	FOX3_DISPLAY_OPTIONS_S		Display Parameters for Structure Explosion	20100514
12	GS_REQUEST	Instance attribute	Protected	☐	Type reference (TYPE)	FOX3_REQUEST_S		Requests to the FOX	20100514
13	GS_UTIL_IF	Instance attribute	Protected	☐	Attribute reference (LIKE)			Structure with Utility Interfaces	20100514
14	GT_EXPLODER	Instance attribute	Protected	☐	Type reference (TYPE)	FOX3_EXPLODER_T		Exploder for a Profile	20100514
15	GT_EXPLODER_INST	Instance attribute	Protected	☐	Type reference (TYPE)	FOX3_EXPLODER_INST_T		Exploder for a Profile	20100514
16	GT_PROFILE_INST	Instance attribute	Protected	☐	Type reference (TYPE)	FOX3_PROFILE_INST_T		Profile with Status and Instance	20100514
17	GT_REQUEST	Instance attribute	Protected	☐	Type reference (TYPE)	FOX3_REQUEST_T		Requests to the FOX	20100514
18	GV_CURRENT_DIRECTION	Instance attribute	Protected	☐	Type reference (TYPE)	FOX3_EXPL_DIRECTION		Direction of Explosion	20100514
19	GV_CURRENT_PROFILE	Instance attribute	Protected	☐	Type reference (TYPE)	FOX0_PROFILE		FOX Explosion Profile	20100514
20	GV_DB_VERSION	Instance attribute	Protected	☐	Type reference (TYPE)	FOX3_DB_VERSION		Counter for Versioning	20100514
21	GV_DELETE_EXTENT	Instance attribute	Protected	☐	Attribute reference (LIKE)			Scope of Storage	20100514
22	GV_DELETE_FAILED	Instance attribute	Public	☐	Attribute reference (LIKE)				20100514
23	GV_DELETE_REQUESTED	Instance attribute	Protected	☐	Type reference (TYPE)	FLAG_X		Indicator	20100514
24	GV_FORCE_DELETE	Instance attribute	Protected	☐	Attribute reference (LIKE)				20100514
25	GV_FREED	Instance attribute	Public	☐	Attribute reference (LIKE)				20100514
26	GV_HAS_CHANGED	Instance attribute	Protected	☐	Type reference (TYPE)	FLAG_X		Changes Since Last Save	20100514
27	GV_HAS_LOCK	Instance attribute	Protected	☐	Type reference (TYPE)	FLAG_X		Lock set	20100514
28	GV_INCONSISTENT	Instance attribute	Protected	☐	Type reference (TYPE)	FOX3_INCONSISTENT		Inconsistent Data	20100514
29	GV_ONLY_ONE_COMMIT	Instance attribute	Protected	☐	Attribute reference (LIKE)				20100514
30	GV_OWN_LOG	Instance attribute	Protected	☐	Type reference (TYPE)	FOX3_OWN_LOG		Own Application Log	20100514
31	GV_PREVIOUS_TIMING_MESSAGE	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_PTU_MESSAGE		Collect Messages	20100514
32	GV_PREVIOUS_TRACE_LEVEL	Instance attribute	Protected	☐	Type reference (TYPE)	PTU_TRACE_LEVEL		Trace Level	20100514
33	GV_READ_FAILED	Instance attribute	Public	☐	Attribute reference (LIKE)				20100514
34	GV_REQUEST_ID	Instance attribute	Public	☑	Type reference (TYPE)	FOX3_REQUEST_ID		FOX Request ID	20100514
35	GV_SAVE_AND_FREE	Instance attribute	Protected	☐	Type reference (TYPE)	FLAG_X		FREE after SAVE	20100514
36	GV_SAVE_REQUESTED	Instance attribute	Protected	☐	Type reference (TYPE)	FLAG_X		Indicator	20100514
37	GV_SOURCE	Instance attribute	Protected	☐	Type reference (TYPE)	FOX3_DATA_SOURCE		Type of Data Source	20100514
38	GV_START_OF_EXPLOSION	Instance attribute	Protected	☐	Type reference (TYPE)	FOX3_START_OF_EXPLOSION		Start Time for Explosion	20100514
39	GV_TA_TYPE	Instance attribute	Public	☐	Attribute reference (LIKE)			Type of Transaction	20100514
40	GV_TEST	Instance attribute	Protected	☐	Type reference (TYPE)	FOX3_TEST		Test Indicator	20100514
41	GV_TOTAL_OBJECTS	Instance attribute	Protected	☐	Type reference (TYPE)	I		All Objects Found	20100514
42	GV_TRACE_LEVEL	Instance attribute	Protected	☐	Type reference (TYPE)	PTU_TRACE_LEVEL		Trace Level	20100514
43	GV_USE_DB	Instance attribute	Protected	☐	Type reference (TYPE)	FLAG_X		Data Store Allowed	20100514
44	GV_WRITE_FAILED	Instance attribute	Public	☐	Attribute reference (LIKE)				20100514
45	SI_FOX_REQUEST_BADI	Static Attribute	Protected	☐	Object reference (TYPE REF TO)	IF_EX_FOX3_REQUEST_USED		Use of FLOB	20100514
46	ST_FACTORY	Static Attribute	Protected	☐	See coding				20100514
47	SV_FOX_REQUEST_BADI_ACTIVE	Static Attribute	Protected	☐	Type reference (TYPE)	FLAG_X		BAdI Active	20100514
48	SV_MSG_DUMMY	Static Attribute	Protected	☐	Type reference (TYPE)	CHAR1		Single-Character Indicator	20100514

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ANALYZE	Instance method	Public	Method	Analysis of All Explosions	20100514
2	ANALYZE_EXPLOSION	Instance method	Public	Method	Analyze Explosion Result	20100514
3	CHECKS_BEFORE_EXPLOSION	Instance method	Protected	Method	Checks Before Explosion	20100514
4	CLASS_CONSTRUCTOR	Static method	Public	Constructor	CLASS_CONSTRUCTOR	20100514
5	COLLECT_FOREIGN_KEY_OBJECTS	Instance method	Protected	Method	Collect Foreign Key Objects	20100514
6	COMMIT_LUW	Instance method	Protected	Method		20100514
7	CONSTRUCTOR	Instance method	Private	Constructor	CONSTRUCTOR	20100514
8	CREATE_EXPLODER	Instance method	Protected	Method	Create Exploder	20100514
9	CREATE_EXPLODER_ENTRY	Instance method	Private	Method	Generate Entry for an Exploder	20100514
10	CREATE_FOREIGN_KEY_PROFILE	Instance method	Public	Method	Create Explosion Profile for Foreign Key Objects	20100514
11	CREATE_PROFILE	Instance method	Protected	Method	Create Profile	20100514
12	CREATE_REQUEST_ENTRY	Instance method	Private	Method	Generate Entry for a Query	20100514
13	DELETE_FROM_MEMORY	Static method	Public	Method	Delete Request from the Memory	20100514
14	DEQUEUE	Instance method	Protected	Method	Reset Lock	20100514
15	ENQUEUE	Instance method	Protected	Method	Set Lock	20100514
16	EXPLODE_BOTTOM_UP	Instance method	Public	Method	Top-Down Explosion	20100514
17	EXPLODE_TOP_DOWN	Instance method	Public	Method	Explode Top-Level Objects	20100514
18	FIND_WHERE_USED	Instance method	Public	Method	Where-Used List for Changed Objects	20100514
19	FREE_DATA	Instance method	Public	Method		20100514
20	GET_ACTUAL_MEMORY	Instance method	Public	Method		20100514
21	GET_ALL_REQUEST_IDS	Static method	Public	Method	Get All Requests	20100514
22	GET_EXPLODER_DB	Instance method	Protected	Method	Read Request Profile Table	20100514
23	GET_FOREIGN_KEY_OBJECTS	Instance method	Public	Method	Find Foreign Key Objects	20100514
24	GET_INSTANCE	Static method	Public	Method	Constructor Method	20100514
25	GET_PARAMETERS	Instance method	Public	Method	Output Current Parameters	20100514
26	GET_REQUEST_DB	Instance method	Protected	Method	Read Request Table	20100514
27	GET_REQUEST_ID	Instance method	Private	Method	Determine Request ID from the Number Range	20100514
28	GET_STATISTIC	Instance method	Public	Method	Output Statistical Information	20100514
29	GET_TABLES	Instance method	Public	Method	Output Tables	20100514
30	HANDLE_DELETE_FAILED	Instance method	Protected	Method	Deletion Failed	20100514
31	HANDLE_READ_FAILED	Instance method	Protected	Method	Read Operation Failed	20100514
32	HANDLE_WRITE_FAILED	Instance method	Protected	Method	Writing Operation Failed	20100514
33	IS_REQUEST_USED	Static method	Public	Method	Is the Request Still in Use?	20100514
34	LOG_ACTUAL_MEMORY	Instance method	Public	Method		20100514
35	LOG_DIRECTION_CHANGE	Instance method	Protected	Method	Log Direction of Explosion	20100514
36	LOG_PROFILE_CHANGE	Instance method	Protected	Method	Log Change of Profile	20100514
37	NEXT_REQUEST_RECORD	Instance method	Protected	Method	Next Entry in the Header Table	20100514
38	OPEN_LUW	Instance method	Protected	Method		20100514
39	POST_PROCESSING	Instance method	Protected	Method	Rework	20100514
40	PRE_PROCESSING	Instance method	Protected	Method	Preliminary steps	20100514
41	READ_DATA	Instance method	Protected	Method	Read data	20100514
42	REQUEST_DELETE	Instance method	Public	Method		20100514
43	REQUEST_SAVE	Instance method	Public	Method		20100514
44	SET_DB_VERSION	Instance method	Private	Method	Set Database Version	20100514
45	SET_OPTIONS	Instance method	Public	Method	Set Options	20100514
46	SET_SAVE_MODE	Instance method	Public	Method	Set SAVE Mode: SAVE or SAVE and FREE	20100514
47	SET_UI_OPTIONS	Instance method	Protected	Method	Change UI Settings	20100514
48	SET_UP_EXPLODERS	Instance method	Protected	Method	Format Explosions	20100514
49	SET_UP_LOG	Instance method	Protected	Method	Prepare Application Log	20100514
50	SET_UP_REQUEST	Instance method	Protected	Method	Prepare Request	20100514
51	UPDATE_UTILITIES	Instance method	Public	Method		20100514

Events

#	Event	Type	Visibility	Description	Created on
1	REQUEST_CREATED	Instance Event (0)	Public (2)	Creating Request	20100514
2	REQUEST_DELETED	Instance Event (0)	Public (2)	Deleting Request from Memory	20100514

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TS_FACTORY	Protected	See coding			20100514	begin of TS_FACTORY, request_id type fox3_request_id, instance type ref to cl_fox3_request, end of TS_FACTORY

Method Signatures

Method ANALYZE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_TITLE_TEXT	Call by reference	☑	Type reference (TYPE)	FOX3_TITLE_TEXT_T		Text for List Headers	20100514
2	Importing	IV_ASK_BEFORE_LEAVE	Call by reference	☐	Type reference (TYPE)	FLAG_X	'X'	Indicator	20100514
3	Importing	IV_FIRST_SCREEN	Call by reference	☑	Type reference (TYPE)	SYUCOMM		Screens, Function Code Triggered by PAI	20100514

#	Exception	Resumable	Description	Created on
1	ANALYSIS_ERROR	☐	Error During Analysis	20100514

Method ANALYZE_EXPLOSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_TOP_OBJECT	Call by reference	☐	Type reference (TYPE)	FOX3_OBJECT_KEY_S		Generic Object Key for Factory	20100514
2	Importing	IT_TITLE_TEXT	Call by reference	☑	Type reference (TYPE)	FOX3_TITLE_TEXT_T		Text for List Headers	20100514
3	Importing	IV_ALL_EXPLOSIONS	Call by reference	☑	Type reference (TYPE)	FLAG_X		All Explosions	20100514
4	Importing	IV_ASK_BEFORE_LEAVE	Call by reference	☐	Type reference (TYPE)	FLAG_X	'X'	Query Before Exit	20100514
5	Importing	IV_DIRECTION	Call by reference	☐	Type reference (TYPE)	FOX3_EXPL_DIRECTION		Direction of Explosion	20100514
6	Importing	IV_FIRST_SCREEN	Call by reference	☑	Type reference (TYPE)	SYUCOMM		Screens, Function Code Triggered by PAI	20100514
7	Importing	IV_PROFILE	Call by reference	☐	Type reference (TYPE)	FOX0_PROFILE		FOX Explosion Profile	20100514
8	Importing	IV_SOURCE	Call by reference	☐	Type reference (TYPE)	FOX3_DATA_SOURCE		Type of Data Source	20100514

#	Exception	Resumable	Description	Created on
1	ANALYSIS_ERROR	☐	Error During Analysis	20100514

Method CHECKS_BEFORE_EXPLOSION Signature

Method CHECKS_BEFORE_EXPLOSION on class CL_FOX3_REQUEST has no parameter.

#	Exception	Resumable	Description	Created on
1	INCONSISTENT	☐	Inconsistent Data	20100514
2	NO_AUTHORITY	☐	No Authorization	20100514
3	WRONG_TA_TYPE	☐	Incorrect Transaction Type	20100514

Method CLASS_CONSTRUCTOR Signature

Method CLASS_CONSTRUCTOR on class CL_FOX3_REQUEST has no parameter.
Method CLASS_CONSTRUCTOR on class CL_FOX3_REQUEST 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_REQUEST has no exception.

Method COMMIT_LUW Signature

Method COMMIT_LUW on class CL_FOX3_REQUEST has no parameter.
Method COMMIT_LUW on class CL_FOX3_REQUEST has no exception.

Method CONSTRUCTOR 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
2	Importing	IS_UTIL_IF	Call by reference	☐	Type reference (TYPE)	PTU_UTIL_IF_S		Structure with Utility Interfaces	20100514
3	Importing	IV_REQUEST_ID	Call by reference	☐	Type reference (TYPE)	FOX3_REQUEST_ID		FOX Request ID	20100514
4	Importing	IV_START_OF_EXPLOSION	Call by reference	☐	Type reference (TYPE)	FOX3_START_OF_EXPLOSION		Start Time for Explosion	20100514
5	Importing	IV_TA_TYPE	Call by reference	☐	Type reference (TYPE)	FOX3_TA_TYPE		Type of Transaction	20100514
6	Importing	IV_TEST	Call by reference	☐	Type reference (TYPE)	FOX3_TEST		Test Indicator	20100514
7	Importing	IV_TRACE_LEVEL	Call by reference	☐	Type reference (TYPE)	PTU_TRACE_LEVEL		Trace Level	20100514

#	Exception	Resumable	Description	Created on
1	ENQUEUE_ERROR	☐	Error when locking	20100514
2	NOT_FOUND	☐	Request Not Found	20100514
3	NO_AUTHORITY	☐	No Authorization	20100514

Method CREATE_EXPLODER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_EXPLODER_INST	Call by reference	☐	Type reference (TYPE)	FOX3_EXPLODER_INST_S		Exploder for a Profile	20100514
2	Importing	IV_PROFILE	Call by reference	☐	Type reference (TYPE)	FOX0_PROFILE		FOX Explosion Profile	20100514

Method CREATE_EXPLODER on class CL_FOX3_REQUEST has no exception.

Method CREATE_EXPLODER_ENTRY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_CREATED	Call by reference	☐	Type reference (TYPE)	FLAG_X		Indicator	20100514
2	Importing	IS_EXPLODER	Call by reference	☐	Type reference (TYPE)	FOX3_EXPLODER_S		FOX Explosions for a Profile	20100514

Method CREATE_EXPLODER_ENTRY on class CL_FOX3_REQUEST has no exception.

Method CREATE_FOREIGN_KEY_PROFILE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_PROFILE	Call by reference	☐	Type reference (TYPE)	FOX0_PROFILE		FOX Explosion Profile	20100514
2	Importing	IT_OBJECT_TYPE	Call by reference	☐	Type reference (TYPE)	FOX3_OBJ_TYPE_T		Table of Object Types	20100514
3	Importing	IV_TRACE_LEVEL	Call by reference	☐	Type reference (TYPE)	PTU_TRACE_LEVEL	CL_PTU_CONSTANTS=>GC_TRACE_ADDITIONAL	Trace Level	20100514

#	Exception	Resumable	Description	Created on
1	INCONSISTENT	☐	Error reading data	20100514
2	NO_AUTHORITY	☐	No Authorization	20100514
3	PROFILE_INCONSISTENT	☐	Generated Profile Is Inconsistent	20100514
4	WRONG_TA_TYPE	☐	Incorrect Transaction Type	20100514

Method CREATE_PROFILE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_PROFILE_INST	Call by reference	☐	Type reference (TYPE)	FOX3_PROFILE_INST_S		Profile with Status and Instance	20100514
2	Importing	IV_PROFILE	Call by reference	☐	Type reference (TYPE)	FOX0_PROFILE		FOX Explosion Profile	20100514

Method CREATE_PROFILE on class CL_FOX3_REQUEST has no exception.

Method CREATE_REQUEST_ENTRY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_CREATED	Call by reference	☐	Type reference (TYPE)	FLAG_X		Indicator	20100514
2	Importing	IS_REQUEST	Call by reference	☐	Type reference (TYPE)	FOX3_REQUEST_S		Request to the FOX	20100514

Method CREATE_REQUEST_ENTRY on class CL_FOX3_REQUEST has no exception.

Method DELETE_FROM_MEMORY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_REQUEST_ID	Call by reference	☐	Type reference (TYPE)	FOX3_REQUEST_ID		FOX Request ID	20100514

#	Exception	Resumable	Description	Created on
1	NOT_IN_MEMORY	☐	Request Is Not in Memory	20100514

Method DEQUEUE Signature

Method DEQUEUE on class CL_FOX3_REQUEST has no parameter.
Method DEQUEUE on class CL_FOX3_REQUEST has no exception.

Method ENQUEUE Signature

Method ENQUEUE on class CL_FOX3_REQUEST has no parameter.

#	Exception	Resumable	Description	Created on
1	ENQUEUE_ERROR	☐	Error when locking	20100514

Method EXPLODE_BOTTOM_UP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_OBJECTS_TO_EXPLODE	Call by reference	☐	Type reference (TYPE)	FOX3_OBJECTS_TO_EXPLODE_BU_T		Objects to Be Exploded	20100514
2	Exporting	EV_ERROR_DURING_EXPLOSION	Call by reference	☐	Type reference (TYPE)	FOX3_EXPLOSION_ERROR		Explosion Error	20100514
3	Importing	II_VISITOR	Call by reference	☑	Object reference (TYPE REF TO)	IF_FOX3_OBJECT_VISITOR		Visitor Interface for a FOX Object	20100514
4	Importing	IV_RESULT_MODE	Call by reference	☐	Type reference (TYPE)	FOX3_RESULT_MODE	CL_FOX3_CONSTANTS=>GC_RESULT_ONCE_PER_CONTEXT	Return of Explosion Results (See CL_FOX_CONSTANTS)	20100514
5	Importing	IV_SORTED_BY_KEYS	Call by reference	☑	Type reference (TYPE)	FOX3_SORTED_BY_KEYS		Objects Sorted by Keys	20100514

#	Exception	Resumable	Description	Created on
1	INCONSISTENT	☐	Error reading data	20100514
2	NO_AUTHORITY	☐	No Authorization	20100514
3	WRONG_TA_TYPE	☐	Incorrect Transaction Type	20100514

Method EXPLODE_TOP_DOWN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_OBJECTS_TO_EXPLODE	Call by reference	☐	Type reference (TYPE)	FOX3_OBJECTS_TO_EXPLODE_T		Objects to Be Exploded	20100514
2	Exporting	ET_PSEUDO_EXPLOSION	Call by reference	☐	Type reference (TYPE)	FOX3_PROF_PSEUDO_EXPLOSION_T		Conversion of Derived Explosion with Profile	20100514
3	Exporting	EV_ERROR_DURING_EXPLOSION	Call by reference	☐	Type reference (TYPE)	FOX3_EXPLOSION_ERROR		Explosion Error	20100514
4	Importing	II_VISITOR	Call by reference	☑	Object reference (TYPE REF TO)	IF_FOX3_OBJECT_VISITOR		Visitor Interface for a FOX Object	20100514
5	Importing	IV_DO_NOT_EXPLODE	Call by reference	☑	Type reference (TYPE)	FLAG_X		Do Not Explode	20100514
6	Importing	IV_OPTIMIZE_VISITS	Call by reference	☑	Type reference (TYPE)	FLAG_X		Minimize Visitor Calls	20100514
7	Importing	IV_RESULT_MODE	Call by reference	☐	Type reference (TYPE)	FOX3_RESULT_MODE	CL_FOX3_CONSTANTS=>GC_RESULT_ONCE_PER_CONTEXT	Return of Explosion Results (See CL_FOX_CONSTANTS)	20100514
8	Importing	IV_SORTED_BY_KEYS	Call by reference	☑	Type reference (TYPE)	FOX3_SORTED_BY_KEYS		Objects Sorted by Keys	20100514

#	Exception	Resumable	Description	Created on
1	INCONSISTENT	☐	Error reading data	20100514
2	NO_AUTHORITY	☐	No Authorization	20100514
3	WRONG_TA_TYPE	☐	Incorrect Transaction Type	20100514

Method FIND_WHERE_USED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_PROFILES	Call by reference	☐	Type reference (TYPE)	FOX3_PROFILE_STATUS_T		Profile with Status	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_ERROR_DURING_EXPLOSION	Call by reference	☐	Type reference (TYPE)	FOX3_EXPLOSION_ERROR		Explosion Error	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	INCONSISTENT	☐	Error reading data	20100514
2	NO_AUTHORITY	☐	No Authorization	20100514
3	WRONG_TA_TYPE	☐	Incorrect Transaction Type	20100514

Method FREE_DATA Signature

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

Method GET_ACTUAL_MEMORY Signature

Method GET_ACTUAL_MEMORY on class CL_FOX3_REQUEST has no parameter.
Method GET_ACTUAL_MEMORY on class CL_FOX3_REQUEST has no exception.

Method GET_ALL_REQUEST_IDS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_REQUEST_ID	Call by reference	☐	Type reference (TYPE)	FOX3_REQUEST_ID_T		Table of Requests	20100514

Method GET_ALL_REQUEST_IDS on class CL_FOX3_REQUEST has no exception.

Method GET_EXPLODER_DB Signature

Method GET_EXPLODER_DB on class CL_FOX3_REQUEST has no parameter.

#	Exception	Resumable	Description	Created on
1	FAILED	☐	Request Not Found	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	Importing	IV_PROFILE	Call by reference	☑	Type reference (TYPE)	FOX0_PROFILE		FOX Explosion Profile	20100514
3	Importing	IV_USE_EXISTING_EXPLOSIONS	Call by reference	☑	Type reference (TYPE)	FLAG_X		Indicator	20100514

#	Exception	Resumable	Description	Created on
1	INCONSISTENT	☐	Error reading data	20100514
2	NO_AUTHORITY	☐	No Authorization	20100514
3	WRONG_TA_TYPE	☐	Incorrect Transaction Type	20100514

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EO_REQUEST2	Call by reference	☐	Object reference (TYPE REF TO)	CL_FOX3_REQUEST		FOX API Class for Processing Requests	20100514
2	Exporting	EV_INCONSISTENT	Call by reference	☐	Type reference (TYPE)	FLAG_X		Inconsistent Data	20100514
3	Importing	IS_DISPLAY_OPTIONS	Value transfer	☑	Type reference (TYPE)	FOX3_DISPLAY_OPTIONS_S		Display Parameters for Structure Explosion	20100514
4	Importing	IS_UTIL_IF	Call by reference	☑	Type reference (TYPE)	PTU_UTIL_IF_S		Structure with Utility Interfaces	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_TA_TYPE	Call by reference	☐	Type reference (TYPE)	FOX3_TA_TYPE		Type of Transaction	20100514
8	Importing	IV_TEST	Call by reference	☑	Type reference (TYPE)	FOX3_TEST		Test Indicator	20100514
9	Importing	IV_TRACE_LEVEL	Call by reference	☑	Type reference (TYPE)	PTU_TRACE_LEVEL		Trace Level	20100514
10	Importing	IV_USE_DUMMY_ID	Call by reference	☑	Type reference (TYPE)	FLAG_X		Use Default Request ID	20100514

#	Exception	Resumable	Description	Created on
1	ENQUEUE_ERROR	☐	Error when locking	20100514
2	INVALID_REQUEST_ID	☐	Invalid Request Number	20100514
3	NOT_FOUND	☐	Request Not Found	20100514
4	NO_AUTHORITY	☐	No Authorization	20100514

Method GET_PARAMETERS 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
2	Exporting	EV_DATA_SOURCE	Call by reference	☐	Type reference (TYPE)	FOX3_DATA_SOURCE		Type of Data Source	20100514
3	Exporting	EV_INCONSISTENT	Call by reference	☐	Type reference (TYPE)	FOX3_INCONSISTENT		Inconsistent Data	20100514
4	Exporting	EV_START_OF_EXPLOSION	Call by reference	☐	Type reference (TYPE)	FOX3_START_OF_EXPLOSION		Start Time for Explosion	20100514
5	Exporting	EV_TEST	Call by reference	☐	Type reference (TYPE)	FOX3_TEST		Test Indicator	20100514

Method GET_PARAMETERS on class CL_FOX3_REQUEST has no exception.

Method GET_REQUEST_DB Signature

Method GET_REQUEST_DB on class CL_FOX3_REQUEST has no parameter.

#	Exception	Resumable	Description	Created on
1	NOT_FOUND	☐	Request Not Found	20100514

Method GET_REQUEST_ID Signature

Method GET_REQUEST_ID on class CL_FOX3_REQUEST has no parameter.
Method GET_REQUEST_ID on class CL_FOX3_REQUEST has no exception.

Method GET_STATISTIC Signature

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

Method GET_STATISTIC on class CL_FOX3_REQUEST has no exception.

Method GET_TABLES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_REQUEST	Call by reference	☐	Type reference (TYPE)	FOX3_REQUEST_S		Request to the FOX	20100514
2	Exporting	ET_EXPLODER	Call by reference	☐	Type reference (TYPE)	FOX3_EXPLODER_T		Exploder for a Profile	20100514
3	Exporting	ET_EXPLODER_INST	Call by reference	☐	Type reference (TYPE)	FOX3_EXPLODER_INST_T		Exploder for a Profile	20100514
4	Exporting	ET_PROFILE_INST	Call by reference	☐	Type reference (TYPE)	FOX3_PROFILE_INST_T		Profile with Status and Instance	20100514
5	Exporting	ET_REQUEST	Call by reference	☐	Type reference (TYPE)	FOX3_REQUEST_T		Requests to the FOX	20100514

Method GET_TABLES on class CL_FOX3_REQUEST has no exception.

Method HANDLE_DELETE_FAILED Signature

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

Method HANDLE_READ_FAILED Signature

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

Method HANDLE_WRITE_FAILED Signature

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

Method IS_REQUEST_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		Indicator	20100514
2	Importing	II_MESSAGE	Call by reference	☐	Object reference (TYPE REF TO)	IF_PTU_MESSAGE		Collect Messages	20100514
3	Importing	IV_REQUEST_ID	Call by reference	☐	Type reference (TYPE)	FOX3_REQUEST_ID		FOX Request ID	20100514

Method IS_REQUEST_USED on class CL_FOX3_REQUEST has no exception.

Method LOG_ACTUAL_MEMORY Signature

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

Method LOG_DIRECTION_CHANGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_DIRECTION	Call by reference	☐	Type reference (TYPE)	FOX3_EXPL_DIRECTION		Direction of Explosion	20100514

Method LOG_DIRECTION_CHANGE on class CL_FOX3_REQUEST has no exception.

Method LOG_PROFILE_CHANGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_PROFILE	Call by reference	☐	Type reference (TYPE)	FOX0_PROFILE		FOX Explosion Profile	20100514

Method LOG_PROFILE_CHANGE on class CL_FOX3_REQUEST has no exception.

Method NEXT_REQUEST_RECORD Signature

Method NEXT_REQUEST_RECORD on class CL_FOX3_REQUEST has no parameter.
Method NEXT_REQUEST_RECORD on class CL_FOX3_REQUEST has no exception.

Method OPEN_LUW Signature

Method OPEN_LUW on class CL_FOX3_REQUEST has no parameter.
Method OPEN_LUW on class CL_FOX3_REQUEST has no exception.

Method POST_PROCESSING Signature

Method POST_PROCESSING on class CL_FOX3_REQUEST has no parameter.
Method POST_PROCESSING on class CL_FOX3_REQUEST has no exception.

Method PRE_PROCESSING Signature

Method PRE_PROCESSING on class CL_FOX3_REQUEST has no parameter.
Method PRE_PROCESSING on class CL_FOX3_REQUEST has no exception.

Method READ_DATA Signature

Method READ_DATA on class CL_FOX3_REQUEST has no parameter.

#	Exception	Resumable	Description	Created on
1	FAILED	☐	Error reading data	20100514

Method REQUEST_DELETE Signature

Method REQUEST_DELETE on class CL_FOX3_REQUEST has no parameter.
Method REQUEST_DELETE on class CL_FOX3_REQUEST has no exception.

Method REQUEST_SAVE Signature

Method REQUEST_SAVE on class CL_FOX3_REQUEST has no parameter.
Method REQUEST_SAVE on class CL_FOX3_REQUEST has no exception.

Method SET_DB_VERSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_DB_VERSION	Call by reference	☐	Type reference (TYPE)	FOX3_DB_VERSION		Counter for Versioning	20100514

Method SET_DB_VERSION on class CL_FOX3_REQUEST 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_REQUEST has no exception.

Method SET_SAVE_MODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_SAVE_AND_FREE	Call by reference	☐	Type reference (TYPE)	FLAG_X	SPACE	Indicator	20100514

Method SET_SAVE_MODE on class CL_FOX3_REQUEST 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_REQUEST has no exception.

Method SET_UP_EXPLODERS Signature

Method SET_UP_EXPLODERS on class CL_FOX3_REQUEST has no parameter.

#	Exception	Resumable	Description	Created on
1	FAILED	☐	Error reading data	20100514

Method SET_UP_LOG Signature

Method SET_UP_LOG on class CL_FOX3_REQUEST has no parameter.
Method SET_UP_LOG on class CL_FOX3_REQUEST has no exception.

Method SET_UP_REQUEST Signature

Method SET_UP_REQUEST on class CL_FOX3_REQUEST has no parameter.

#	Exception	Resumable	Description	Created on
1	ENQUEUE_ERROR	☐	Error when locking	20100514
2	NOT_FOUND	☐	Request Not Found	20100514
3	NO_AUTHORITY	☐	No Authorization	20100514

Method UPDATE_UTILITIES Signature

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

Event Signatures

Event REQUEST_CREATED Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	II_PERSISTENCE_CONTROLLER	Exporting	Value transfer	☐	Object reference (TYPE REF TO)	IF_FOX3_PERSISTENCE_CONTROLLER		Control of Persistence	20100514

Event REQUEST_DELETED Signature
Event REQUEST_DELETED on class CL_FOX3_REQUEST has no parameter.

History

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