SAP ABAP Class CL_AR_FACTORY (Archiving Factory Handler)

Hierarchy

☛ SAP_ABA (Software Component) Cross-Application Component
   ⤷ CA-FS-ARE (Application Component) Archiving Engine
     ⤷ ARFA_ARCHIVING_FACTORY (Package) Archiving Factory

Properties

Class	CL_AR_FACTORY
Short Description	Archiving Factory Handler
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	ARFA_ARCHIVING_FACTORY	Archiving Factory
Created	20050324	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	ABAP	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
2	ARFA	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
3	ICON	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
4	SEOC	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_AR_FACTORY has no interface implemented.

Friends

Class CL_AR_FACTORY has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	F_MODEL	Static Attribute	Public	☐	Type reference (TYPE)	TYP_F_MODEL		Model	20050620
2	GC_DEVCLASSINITIAL	Constant	Private	☐	Type reference (TYPE)	DEVCLASS	''	Initial Package	20090122
3	GC_DEVCLASSTMP	Constant	Private	☐	Type reference (TYPE)	DEVCLASS	'$TMP'	$tmp Package	20090122
4	O_ARNODE_SELECTED	Static Attribute	Public	☐	Object reference (TYPE REF TO)	CL_AR_NODE		Archiving Factory: Class Nodes	20050427
5	O_CONTAINER	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CL_GUI_DOCKING_CONTAINER		Container for Custom Controls in Screen Area	20050603
6	O_PICTURE	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CL_GUI_PICTURE		SAP Picture Control	20051103
7	O_PICTURECONT	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CL_GUI_CUSTOM_CONTAINER		Container for Custom Controls in Screen Area	20051103
8	O_SPLITTER	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CL_GUI_SPLITTER_CONTAINER		Splitter Control	20050603
9	O_TREECONT	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CL_GUI_DOCKING_CONTAINER		Docking Control Container	20050401
10	P_CHANGEMODE	Static Attribute	Private	☐	Type reference (TYPE)	XFELD		Mode: Display/Change	20050425
11	P_COMMAND	Static Attribute	Private	☐	Type reference (TYPE)	SALV_DE_FUNCTION		ALV Function	20050427
12	P_DEBUG	Static Attribute	Public	☐	Type reference (TYPE)	SYUCOMM		Debug + Error Message	20060630
13	P_SCREEN	Static Attribute	Public	☐	Type reference (TYPE)	SY-DYNNR		Current Screen Number	20050427
14	P_SUPERUSER	Static Attribute	Public	☐	Type reference (TYPE)	ABAP_BOOL		Checkbox	20050620
15	S_DOCK_VISIBLE	Static Attribute	Private	☐	Type reference (TYPE)	CHAR1		Single-Character Indicator	20060815
16	S_DOCU_VISIBLE	Static Attribute	Private	☐	Type reference (TYPE)	CHAR1		Single-Character Indicator	20090903
17	S_HEIGHT	Static Attribute	Private	☐	Type reference (TYPE)	I			20060815
18	S_LOG_VISIBLE	Static Attribute	Private	☐	Type reference (TYPE)	CHAR1		Single-Character Indicator	20090903
19	S_REF_DOCUVIEW	Static Attribute	Private	☐	Object reference (TYPE REF TO)	LCL_CLOSABLE_VIEW			20060815
20	S_REF_LOGVIEW	Static Attribute	Private	☐	Object reference (TYPE REF TO)	LCL_CLOSABLE_VIEW			20060815
21	S_REF_TREEMODEL	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CL_AR_TREE_MODEL		Model for Archiving Object Tree	20060818
22	T_ENTRY	Static Attribute	Public	☐	Type reference (TYPE)	TYP_T_AR_NODE		Nodes	20050414

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK	Static method	Private	Method	Consistency Check	20050531
2	CLASS_CONSTRUCTOR	Static method	Public	Constructor	CLASS_CONSTRUCTOR	20060816
3	CREATE	Static method	Private	Method	Create	20050511
4	DELETE	Static method	Private	Method	Delete Subtree	20050511
5	DEPLOY	Static method	Private	Method	Recording for Transport	20050621
6	DOCU	Static method	Public	Method	Display Documentation	20060607
7	EXPORT	Static method	Private	Method	Get Version and Make Persistent (Serialization)	20050618
8	GET_FILTER	Static method	Public	Method	Read Filter	20060830
9	IMPORT	Static method	Private	Method	Import Last Checked Active Version	20050620
10	ON_DOUBLECLICK	Static method	Private	Event handling method	Double-Click on Node	20050413
11	ON_FUNCTION	Static method	Private	Event handling method	Display, Change, Create, Delete	20050413
12	PAI	Static method	Public	Method	Process After Input	20050511
13	PBO	Static method	Public	Method	Process Before Output	20050511
14	SAVE	Static method	Private	Method	Save	20050427
15	SET_FILTER	Static method	Public	Method	Set Filter	20060830
16	S_CREATE_DOCU_LOG_CONTAINER	Static method	Private	Method	Create Container Area for Docu and Log Display	20060816
17	S_GENERATE_HDS_SRCFACT_CLASS	Static method	Public	Method	Generate Factory Class for HDS Source	20060921
18	S_GENERATE_RTCFG_CLASS	Static method	Public	Method	Generate Implementation for Runtime Configuration	20070117
19	S_GET_CHANGEMODE	Static method	Public	Method	Get 'Change Mode' Indicator	20060816
20	S_GET_HDS_SOURCE_CLASS	Static method	Private	Method	Get Implementing Class for HDS Source	20060707
21	S_IS_DOCU_VISIBLE	Static method	Private	Method		20060815
22	S_IS_LOG_VISIBLE	Static method	Private	Method		20060815
23	S_ON_CLOSE_CLICKED	Static method	Private	Event handling method		20060815
24	S_REFRESH_DOCU_LOG_VIEW	Static method	Private	Method	Refresh Docu and Log Display	20060815
25	S_SET_CHANGEMODE	Static method	Private	Method	Set 'Change Mode' Indicator	20060816
26	S_SHOW_LOG	Static method	Public	Method	Display Log (if Filled)	20090902
27	S_TRANSPORT_SUBTREE	Static method	Private	Method		20081010
28	TADIR	Static method	Private	Method	Display or Maintenance of TADIR	20051027
29	TOOL_NAVIGATE	Static method	Public	Method	Navigation in Development Tool	20050418

Events

Class CL_AR_FACTORY has no event.

Types

Class CL_AR_FACTORY has no local type.

Method Signatures

Method CHECK Signature

Method CHECK on class CL_AR_FACTORY has no parameter.
Method CHECK on class CL_AR_FACTORY has no exception.

Method CLASS_CONSTRUCTOR Signature

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

Method CREATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_REF_PARENT	Call by reference	☐	Object reference (TYPE REF TO)	CL_AR_NODE		Archiving Factory: Knoten	20060821

Method CREATE on class CL_AR_FACTORY has no exception.

Method DELETE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_REF_NODE	Call by reference	☐	Object reference (TYPE REF TO)	CL_AR_NODE		Archiving Factory: Knoten	20060821

Method DELETE on class CL_AR_FACTORY has no exception.

Method DEPLOY Signature

Method DEPLOY on class CL_AR_FACTORY has no parameter.
Method DEPLOY on class CL_AR_FACTORY has no exception.

Method DOCU Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	P_OBJECT	Call by reference	☐	Type reference (TYPE)	TYP_AR_OBJECT		Archivierungsszenario	20060607
2	Returning	P_RESULT	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20060607

Method DOCU on class CL_AR_FACTORY has no exception.

Method EXPORT Signature

Method EXPORT on class CL_AR_FACTORY has no parameter.
Method EXPORT on class CL_AR_FACTORY has no exception.

Method GET_FILTER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_FILTER	Value transfer	☐	Type reference (TYPE)	TYP_R_AR_SCENARIO		Archivierungsscenario	20060830

Method GET_FILTER on class CL_AR_FACTORY has no exception.

Method IMPORT Signature

Method IMPORT on class CL_AR_FACTORY has no parameter.
Method IMPORT on class CL_AR_FACTORY has no exception.

Method ON_DOUBLECLICK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	REF_SELECTED_NODE	Call by reference	☐	Attribute reference (LIKE)				20060818

Method ON_DOUBLECLICK on class CL_AR_FACTORY has no exception.

Method ON_FUNCTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FCODE	Call by reference	☐	Attribute reference (LIKE)				20060818
2	Importing	REF_SELECTED_NODE	Call by reference	☐	Attribute reference (LIKE)				20060818

Method ON_FUNCTION on class CL_AR_FACTORY has no exception.

Method PAI Signature

Method PAI on class CL_AR_FACTORY has no parameter.
Method PAI on class CL_AR_FACTORY has no exception.

Method PBO Signature

Method PBO on class CL_AR_FACTORY has no parameter.
Method PBO on class CL_AR_FACTORY has no exception.

Method SAVE Signature

Method SAVE on class CL_AR_FACTORY has no parameter.
Method SAVE on class CL_AR_FACTORY has no exception.

Method SET_FILTER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	R_FILTER	Call by reference	☐	Type reference (TYPE)	TYP_R_AR_SCENARIO		Archivierungsscenario	20060830

Method SET_FILTER on class CL_AR_FACTORY has no exception.

Method S_CREATE_DOCU_LOG_CONTAINER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_DYNNR	Call by reference	☐	Type reference (TYPE)	SY-DYNNR		Aktuelle Dynpro-Nummer	20060816
2	Importing	I_REPID	Call by reference	☐	Type reference (TYPE)	SYREPID		ABAP-Programm, aktuelles Rahmenprogramm	20060816

Method S_CREATE_DOCU_LOG_CONTAINER on class CL_AR_FACTORY has no exception.

Method S_GENERATE_HDS_SRCFACT_CLASS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_CLASSNAME	Call by reference	☐	Type reference (TYPE)	TARCHENGINE01-CLSRCFACT		HDS Implementierung	20060921
2	Exporting	E_RCD_CREATION	Call by reference	☐	Type reference (TYPE)	SY-SUBRC		Rückgabewert von ABAP-Anweisungen	20060921

Method S_GENERATE_HDS_SRCFACT_CLASS on class CL_AR_FACTORY has no exception.

Method S_GENERATE_RTCFG_CLASS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_CLASSNAME	Call by reference	☐	Type reference (TYPE)	AREN_DTE_CLASS_RUNTIME_CONFIG			20070117
2	Exporting	E_RCD_CREATION	Call by reference	☐	Type reference (TYPE)	SY-SUBRC		Rückgabewert von ABAP-Anweisungen	20070117

Method S_GENERATE_RTCFG_CLASS on class CL_AR_FACTORY has no exception.

Method S_GET_CHANGEMODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_FLG_CHANGE	Value transfer	☐	Type reference (TYPE)	XFELD		Feld zum Ankreuzen	20060816

Method S_GET_CHANGEMODE on class CL_AR_FACTORY has no exception.

Method S_GET_HDS_SOURCE_CLASS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_ARCHSCENARIO	Call by reference	☐	Type reference (TYPE)	TYP_AR_OBJECT		Archivierungsszenario	20060707
2	Returning	R_HDS_SOURCECLASS	Value transfer	☐	Type reference (TYPE)	STRING			20060707

Method S_GET_HDS_SOURCE_CLASS on class CL_AR_FACTORY has no exception.

Method S_IS_DOCU_VISIBLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_FLG_TRUE	Value transfer	☐	Type reference (TYPE)	CHAR1		Einstelliges Kennzeichen	20060815

Method S_IS_DOCU_VISIBLE on class CL_AR_FACTORY has no exception.

Method S_IS_LOG_VISIBLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_FLG_TRUE	Value transfer	☐	Type reference (TYPE)	CHAR1		Einstelliges Kennzeichen	20060815

Method S_IS_LOG_VISIBLE on class CL_AR_FACTORY has no exception.

Method S_ON_CLOSE_CLICKED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	SENDER	Call by reference	☐	Attribute reference (LIKE)				20060815

Method S_ON_CLOSE_CLICKED on class CL_AR_FACTORY has no exception.

Method S_REFRESH_DOCU_LOG_VIEW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_FLG_DOCU_VISIBLE	Call by reference	☑	Type reference (TYPE)	CHAR1		Einstelliges Kennzeichen	20060815
2	Importing	I_FLG_LOG_VISIBLE	Call by reference	☑	Type reference (TYPE)	CHAR1		Einstelliges Kennzeichen	20060815

Method S_REFRESH_DOCU_LOG_VIEW on class CL_AR_FACTORY has no exception.

Method S_SET_CHANGEMODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_FLG_CHANGE	Call by reference	☐	Type reference (TYPE)	XFELD		Feld zum Ankreuzen	20060816

Method S_SET_CHANGEMODE on class CL_AR_FACTORY has no exception.

Method S_SHOW_LOG Signature

Method S_SHOW_LOG on class CL_AR_FACTORY has no parameter.
Method S_SHOW_LOG on class CL_AR_FACTORY has no exception.

Method S_TRANSPORT_SUBTREE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_REF_NODE	Call by reference	☐	Object reference (TYPE REF TO)	CL_AR_NODE		Archiving Factory: Knoten	20081010

Method S_TRANSPORT_SUBTREE on class CL_AR_FACTORY has no exception.

Method TADIR Signature

Method TADIR on class CL_AR_FACTORY has no parameter.
Method TADIR on class CL_AR_FACTORY has no exception.

Method TOOL_NAVIGATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	F_TARCHENGINE01	Call by reference	☐	Type reference (TYPE)	TARCHENGINE01		Archivierungsobjekt	20060310

Method TOOL_NAVIGATE on class CL_AR_FACTORY has no exception.

History

Last changed by/on	SAP	20130531
SAP Release Created in	40