SAP ABAP Class CL_AR_OUTPUT (Archiving Engine: Output Lists)

Hierarchy

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

Properties

Class	CL_AR_OUTPUT
Short Description	Archiving Engine: Output Lists
Super Class
Instantiability of a Class	0	Private
Final	☑

General Data

Message Class
Program status
Category	0
Package	ARFA_ARCHIVING_COCKPIT	Archiving Cockpit
Created	20060515	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	CL_AREN_CLUSTER_BINDATA	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)

Interfaces

Class CL_AR_OUTPUT has no interface implemented.

Friends

#	Friend	Modeled only	Created on	Description
1	CL_AR_OUTPUT_FACTORY	☐	20060524	Output Factory

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	ACTION	Instance attribute	Private	☐	Type reference (TYPE)	TYP_P_MODE		Archiving Engine Mode	20060516
2	ARCHIVE_HANDLE	Instance attribute	Private	☐	Type reference (TYPE)	SY-TABIX		Index of Internal Tables	20060523
3	CNT_OBJS_PROCESSED	Instance attribute	Private	☐	Type reference (TYPE)	I			20060622
4	CNT_OBJS_TOTAL	Instance attribute	Private	☐	Type reference (TYPE)	I			20060622
5	CNT_PACKS_PROCESSED	Instance attribute	Private	☐	Type reference (TYPE)	I			20060524
6	CON_PROGR_IND_OBJ	Constant	Private	☐	Type reference (TYPE)	TYP_PROGR_IND_MODE	'O'	Single-Character Indicator	20060622
7	CON_PROGR_IND_PACK	Constant	Private	☐	Type reference (TYPE)	TYP_PROGR_IND_MODE	'P'	Single-Character Indicator	20060622
8	CON_PROT_DATA	Constant	Private	☐	Type reference (TYPE)	CL_AREN_CLUSTER_BINDATA=>TYP_DATANAME	'PROTOCOL'		20060803
9	CON_PROT_MSG_OBJ_ERR	Constant	Private	☐	Type reference (TYPE)	TYP_PROT_MSG_TYPE	2		20060809
10	CON_PROT_MSG_OBJ_OK	Constant	Private	☐	Type reference (TYPE)	TYP_PROT_MSG_TYPE	1		20060809
11	CON_PROT_MSG_OTHER	Constant	Private	☐	Type reference (TYPE)	TYP_PROT_MSG_TYPE	3		20060809
12	CON_STAT_DATA	Constant	Private	☐	Type reference (TYPE)	CL_AREN_CLUSTER_BINDATA=>TYP_DATANAME	SPACE		20060803
13	F_SUPPRESS	Instance attribute	Private	☐	Type reference (TYPE)	TYP_F_SUPPRESSEDOUTPUT		Ind.: 'No List Output'	20060704
14	LOGHANDLE	Instance attribute	Private	☐	Type reference (TYPE)	BALLOGHNDL		Application Log: Log Handle	20060531
15	LOGHANDLE_PARENT	Instance attribute	Private	☐	Type reference (TYPE)	BALLOGHNDL		Application Log: Log Handle	20060531
16	OBJECT	Instance attribute	Private	☐	Type reference (TYPE)	TYP_AR_OBJECT		Archiving Scenario	20060516
17	OPTIONS	Instance attribute	Private	☐	Type reference (TYPE)	TYP_F_AR_OPTIONS		ADK Options	20060517
18	OUTPUT_OBJCATG	Instance attribute	Private	☐	Type reference (TYPE)	AREN_DTE_OUTPUT_OBJCATG		Category of Output Object	20060524
19	O_METADATA	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_AR_METADATA		Metadata for Archiving Engine	20070731
20	PROGR_IND_MODE	Instance attribute	Private	☐	Type reference (TYPE)	TYP_PROGR_IND_MODE		Single-Character Indicator	20060622
21	REF_CONTAINER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_AREN_CLUSTER_BINDATA		Container for Statistical Data	20060803

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CLOSE_ARCHIVE_LOG	Instance method	Private	Method		20060811
2	COLLECT_DATA_FROM_CHILD	Instance method	Public	Method		20060803
3	COMPOSE_OBJECTKEY_STRING	Instance method	Private	Method		20060531
4	GET_ARCHIVING_ACTION	Instance method	Private	Method		20060606
5	GET_DATA	Instance method	Public	Method		20060803
6	GET_LOGHANDLE	Instance method	Public	Method		20060531
7	GET_RUN_MODE	Instance method	Private	Method		20060606
8	INIT	Instance method	Private	Method		20060628
9	IS_PROTOCOL_REQUIRED	Instance method	Private	Method		20060522
10	IS_PROT_OUTPUT_ENABLED	Instance method	Private	Method		20060628
11	IS_STAT_OUTPUT_ENABLED	Instance method	Private	Method		20060628
12	ON_ENGINE_FINISHED	Instance method	Public	Event handling method	End Archiving Engine	20060515
13	ON_ENGINE_STARTED	Instance method	Public	Event handling method	Start Archiving Engine	20060515
14	ON_OBJECT_PROCESSED	Instance method	Public	Event handling method		20060516
15	ON_PACKAGE_ENGINE_BEGIN	Instance method	Public	Event handling method		20060516
16	ON_PACKAGE_ENGINE_END	Instance method	Public	Event handling method		20060516
17	ON_PACKAGE_ENGINE_PREPARED	Instance method	Public	Event handling method		20060517
18	ON_PACKAGE_THREAD_BEGIN	Instance method	Public	Event handling method		20060516
19	ON_PACKAGE_THREAD_END	Instance method	Public	Event handling method		20060516
20	ON_PACKAGE_UNDO	Instance method	Public	Event handling method		20060516
21	ON_THREAD_FINISHED	Instance method	Public	Event handling method		20060516
22	ON_THREAD_STARTED	Instance method	Public	Event handling method		20060516
23	OPEN_ARCHIVE_LOG	Instance method	Private	Method		20060809
24	PROGRESS_INDICATE	Instance method	Private	Method		20060622

Events

#	Event	Type	Visibility	Description	Created on
1	PACKAGE_UNDO	Instance Event (0)	Private (0)		20060516

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TYP_PROGR_IND_MODE	Private	Type reference (TYPE)	CHAR1	Type of Progress Output: P: per Package, 0: per Object	20060622
2	TYP_PROT_MSG_TYPE	Private	Type reference (TYPE)	I		20060809
3	TYP_STAT_BINDATA	Private	Type reference (TYPE)	XSTRING		20060531
4	TYP_TAB_STAT_BINDATA	Private	See coding			20060531	typ_tab_stat_bindata TYPE STANDARD TABLE OF xstring WITH DEFAULT KEY

Method Signatures

Method CLOSE_ARCHIVE_LOG Signature

Method CLOSE_ARCHIVE_LOG on class CL_AR_OUTPUT has no parameter.
Method CLOSE_ARCHIVE_LOG on class CL_AR_OUTPUT has no exception.

Method COLLECT_DATA_FROM_CHILD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_TAB_DATA	Call by reference	☐	Type reference (TYPE)	CL_AREN_CLUSTER_BINDATA=>TYP_TAB_CLUST			20060803

Method COLLECT_DATA_FROM_CHILD on class CL_AR_OUTPUT has no exception.

Method COMPOSE_OBJECTKEY_STRING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_BUSINESSKEY	Call by reference	☐	Type reference (TYPE)	ANY			20060531
2	Returning	R_OBJSTR	Value transfer	☐	Type reference (TYPE)	STRING			20060531

Method COMPOSE_OBJECTKEY_STRING on class CL_AR_OUTPUT has no exception.

Method GET_ARCHIVING_ACTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_ARCH_ACTION	Value transfer	☐	Type reference (TYPE)	ADMI_JOB_T		Typ eines Jobs der Datenarchivierung	20060606

Method GET_ARCHIVING_ACTION on class CL_AR_OUTPUT has no exception.

Method GET_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_TAB_DATA	Value transfer	☐	Type reference (TYPE)	CL_AREN_CLUSTER_BINDATA=>TYP_TAB_CLUST		Daten	20060803

Method GET_DATA on class CL_AR_OUTPUT has no exception.

Method GET_LOGHANDLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_LOG_HANDLE	Value transfer	☐	Type reference (TYPE)	BALLOGHNDL		Anwendungs-Log: Handle eines Protokolls	20060531

Method GET_LOGHANDLE on class CL_AR_OUTPUT has no exception.

Method GET_RUN_MODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_RUN_MODE	Value transfer	☐	Type reference (TYPE)	ARCH_RUN_MODE			20060606

Method GET_RUN_MODE on class CL_AR_OUTPUT has no exception.

Method INIT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	F_SUPPRESS	Call by reference	☐	Type reference (TYPE)	TYP_F_SUPPRESSEDOUTPUT		Boolean	20060704
2	Importing	I_ACTION	Call by reference	☐	Type reference (TYPE)	TYP_P_MODE			20060628
3	Importing	I_LOGHANDLE_PARENT	Call by reference	☐	Type reference (TYPE)	BALLOGHNDL		Anwendungs-Log: Handle eines Protokolls	20060628
4	Importing	I_OBJECT	Call by reference	☐	Type reference (TYPE)	TYP_AR_OBJECT			20060628
5	Importing	I_OUTPUT_OBJCATG	Call by reference	☐	Type reference (TYPE)	AREN_DTE_OUTPUT_OBJCATG		Typ des Ausgabeobjekts	20060628
6	Importing	I_STR_OPTIONS	Call by reference	☐	Type reference (TYPE)	TYP_F_AR_OPTIONS		ADK Optionen	20060628

Method INIT on class CL_AR_OUTPUT has no exception.

Method IS_PROTOCOL_REQUIRED 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)	ABAP_BOOL		Boolean	20060522

Method IS_PROTOCOL_REQUIRED on class CL_AR_OUTPUT has no exception.

Method IS_PROT_OUTPUT_ENABLED 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)	ABAP_BOOL		Boolean	20060628

Method IS_PROT_OUTPUT_ENABLED on class CL_AR_OUTPUT has no exception.

Method IS_STAT_OUTPUT_ENABLED 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)	ABAP_BOOL		Boolean	20060628

Method IS_STAT_OUTPUT_ENABLED on class CL_AR_OUTPUT has no exception.

Method ON_ENGINE_FINISHED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	F_EVENT	Value transfer	☐	Attribute reference (LIKE)				20060516

Method ON_ENGINE_FINISHED on class CL_AR_OUTPUT has no exception.

Method ON_ENGINE_STARTED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	F_EVENT	Value transfer	☐	Attribute reference (LIKE)				20060516

Method ON_ENGINE_STARTED on class CL_AR_OUTPUT has no exception.

Method ON_OBJECT_PROCESSED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	F_EVENT	Value transfer	☐	Attribute reference (LIKE)				20060516

Method ON_OBJECT_PROCESSED on class CL_AR_OUTPUT has no exception.

Method ON_PACKAGE_ENGINE_BEGIN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	F_EVENT	Value transfer	☐	Attribute reference (LIKE)				20060516

Method ON_PACKAGE_ENGINE_BEGIN on class CL_AR_OUTPUT has no exception.

Method ON_PACKAGE_ENGINE_END Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	F_EVENT	Value transfer	☐	Attribute reference (LIKE)				20060516

Method ON_PACKAGE_ENGINE_END on class CL_AR_OUTPUT has no exception.

Method ON_PACKAGE_ENGINE_PREPARED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	F_EVENT	Value transfer	☐	Attribute reference (LIKE)				20060517

Method ON_PACKAGE_ENGINE_PREPARED on class CL_AR_OUTPUT has no exception.

Method ON_PACKAGE_THREAD_BEGIN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	F_EVENT	Value transfer	☐	Attribute reference (LIKE)				20060516

Method ON_PACKAGE_THREAD_BEGIN on class CL_AR_OUTPUT has no exception.

Method ON_PACKAGE_THREAD_END Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	F_EVENT	Value transfer	☐	Attribute reference (LIKE)				20060516

Method ON_PACKAGE_THREAD_END on class CL_AR_OUTPUT has no exception.

Method ON_PACKAGE_UNDO Signature

Method ON_PACKAGE_UNDO on class CL_AR_OUTPUT has no parameter.
Method ON_PACKAGE_UNDO on class CL_AR_OUTPUT has no exception.

Method ON_THREAD_FINISHED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	F_EVENT	Value transfer	☐	Attribute reference (LIKE)				20060516

Method ON_THREAD_FINISHED on class CL_AR_OUTPUT has no exception.

Method ON_THREAD_STARTED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	F_EVENT	Value transfer	☐	Attribute reference (LIKE)				20060516

Method ON_THREAD_STARTED on class CL_AR_OUTPUT has no exception.

Method OPEN_ARCHIVE_LOG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_FATHER_PROTOCOL_HANDLE	Call by reference	☑	Type reference (TYPE)	BALLOGHNDL		Anwendungs-Log: Handle eines Protokolls	20060809
2	Returning	R_LOG_HANDLE	Value transfer	☐	Type reference (TYPE)	BALLOGHNDL		Anwendungs-Log: Handle eines Protokolls	20060809

Method OPEN_ARCHIVE_LOG on class CL_AR_OUTPUT has no exception.

Method PROGRESS_INDICATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_FLG_IMMEDIATE_OUTPUT	Call by reference	☑	Type reference (TYPE)	BOOLE_D		Datenelement zur Domäne BOOLE: TRUE (='X') und FALSE (=' ')	20060622

Method PROGRESS_INDICATE on class CL_AR_OUTPUT has no exception.

Event Signatures

Event PACKAGE_UNDO Signature
Event PACKAGE_UNDO on class CL_AR_OUTPUT has no parameter.

History

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