SAP ABAP Class CL_RECA_ARCHIVING_OBJECT (Archiving Object (Abstract): Standard Implementation)

Hierarchy

☛ EA-FIN (Software Component) EA-FIN
   ⤷ RE-FX (Application Component) Flexible Real Estate Management
     ⤷ RE_CA_AR (Package) RE: Data Archiving

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_RECA_OBJECT	Instanciable Object (Abstract): Standard Implementation	20021125
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_RECA_ARCHIVING_OBJECT	Archiving Object	20021125

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_REAJ_ARCHIVING_OBJECT_ATPS	Archiving Object: Prestage Adjustments for Measures	20121114
2	Inheritance (c INHERITING FROM c_ref)	CL_RECA_ARCHIVING_OBJECT_BO	Archiving Object (Abstract): Business Object	20030221
3	Inheritance (c INHERITING FROM c_ref)	CL_RECA_ARCHIVING_OBJECT_PROC	Archiving Object (Abstract): Process	20050606
4	Inheritance (c INHERITING FROM c_ref)	CL_RECD_ARCHIVING_OBJECT_CF	Archiving Object (Abstract): Cash Flow	20030306
5	Inheritance (c INHERITING FROM c_ref)	CL_REOR_ARCHIVING_OBJECT_RS	Archiving Object: Reservation	20070227
6	Inheritance (c INHERITING FROM c_ref)	CL_RERA_ARCHIVING_OBJECT_RADOC	Archiving Object: RE Document	20030110

Properties

Class	CL_RECA_ARCHIVING_OBJECT
Short Description	Archiving Object (Abstract): Standard Implementation
Super Class	CL_RECA_OBJECT	Instanciable Object (Abstract): Standard Implementation
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status	P	SAP Standard Production Program
Category	0
Package	RE_CA_AR	RE: Data Archiving
Created	20021125	SAP
Last change	20110908	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	RECA1	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
3	RSDS	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_RECA_ARCHIVING_OBJECT	☐	☐	Archiving Object	20021125

Friends

#	Friend	Modeled only	Created on	Description
1	CF_RECA_OBJECT	☐	20021125	Object That Can Be Instantiated: Factory

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MD_ARCHIVE_HANDLE	Instance attribute	Protected	☐	Type reference (TYPE)	SYTABIX		Pointer to Open File	20021125
2	MD_NAME	Instance attribute	Public	☐	Attribute reference (LIKE)				20021125
3	MO_EXIT	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	BADI_RECA_ARCHIVING_OBJECT		BAdI for Archiving Object	20050824

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_DELETE_WITHOUT_ARCHIVING	Instance method	Public	Method		20030110
2	CHECK_DELETION_FLAG_DEL	Instance method	Public	Method		20030622
3	CHECK_DELETION_FLAG_SET	Instance method	Public	Method		20030622
4	CHECK_RESIDENCE_TIME_1	Instance method	Protected	Method	Checks Adherence to Residence Time 1 [Final]	20030305
5	CHECK_RESIDENCE_TIME_2	Instance method	Protected	Method	Checks Adherence to Residence Time 2 [Final]	20030307
6	DELETE	Instance method	Public	Method		20021126
7	DELETE_WITHOUT_ARCHIVING	Instance method	Public	Method		20030319
8	GET_PROPERTIES	Instance method	Protected	Method	Gets Technical Attributes of Archiving Object [Abstract]	20030108
9	GET_SELECTION_BY_AROBJKEY	Instance method	Protected	Method	Gets Selection Criteria for Reading Data Object [Abstract]	20021129
10	GET_STATUS_SUBOBJ_LIST	Instance method	Protected	Method	Gets Subordinate CO Objects to Be Deleted	20030620
11	GET_TEXT_LIST	Instance method	Protected	Method	Gets List of SAPscript Texts for Business Object	20030109
12	INIT	Instance method	Public	Method		20030110
13	ME_CHECK_DELETE_WITHOUT_ARCH	Instance method	Protected	Method	Checks If Deleting the Data Is Allowed [abstract]	20030319
14	ME_CHECK_WRITE_ARCHIVE_DATA	Instance method	Protected	Method	Checks If the Data Object Is to Be Archived [abstract]	20030319
15	ME_DELETE	Instance method	Protected	Method	Deletes Data from Database [abstract]	20030319
16	ME_READ_INTO_BUFFER	Instance method	Protected	Method	Reads Exactly One Data Object from Archive [abstract]	20030319
17	ME_WRITE	Instance method	Protected	Method	Places Data of Data Object in Archive File [abstract]	20030319
18	READ_FROM_ARCHIVE	Instance method	Protected	Method	Reads Data of Data Object from Archive [abstract]	20030107
19	READ_FROM_DB	Instance method	Protected	Method	Reads Data of Data Object from Database [abstract]	20030107
20	READ_INTO_BUFFER	Instance method	Public	Method		20030110
21	SET_DELETION_IND	Instance method	Public	Method		20030622
22	WRITE	Instance method	Public	Method		20030319
23	_DELETE_ARCHIVE_CLOSE	Instance method	Private	Method	Closes Archive File After Deletion	20021126
24	_DELETE_ARCHIVE_OPEN	Instance method	Private	Method	Opens Archive File for Deletion	20021126
25	_DELETE_DATA_ARCLASSES	Instance method	Private	Method	Deletes Data of Archiving Classes from Database	20030107
26	_WRITE_ARCHIVE_CLOSE	Instance method	Private	Method	Closes Archive File After Write	20021126
27	_WRITE_ARCHIVE_DATA_ARCLASSES	Instance method	Private	Method	Writes Data from Archiving Classes to Archive File	20030107
28	_WRITE_ARCHIVE_NEW_OBJECT	Instance method	Private	Method	Requests New Data Object for Writing	20021126
29	_WRITE_ARCHIVE_OPEN	Instance method	Private	Method	Opens Archive File for Writing	20021125
30	_WRITE_ARCHIVE_SAVE_OBJECT	Instance method	Private	Method	Writes Data Object to Archive File	20021126

Events

#	Event	Type	Visibility	Description	Created on
1	AFTER_DELETE_BUSOBJ	Instance Event (0)	Public (2)		20030620
2	BEFORE_DELETE_BUSOBJ	Instance Event (0)	Public (2)		20030620

Types

Class CL_RECA_ARCHIVING_OBJECT has no local type.

Method Signatures

Method CHECK_DELETE_WITHOUT_ARCHIVING Signature

Method CHECK_DELETE_WITHOUT_ARCHIVING on class CL_RECA_ARCHIVING_OBJECT has no parameter.
Method CHECK_DELETE_WITHOUT_ARCHIVING on class CL_RECA_ARCHIVING_OBJECT has no exception.

Method CHECK_DELETION_FLAG_DEL Signature

Method CHECK_DELETION_FLAG_DEL on class CL_RECA_ARCHIVING_OBJECT has no parameter.
Method CHECK_DELETION_FLAG_DEL on class CL_RECA_ARCHIVING_OBJECT has no exception.

Method CHECK_DELETION_FLAG_SET Signature

Method CHECK_DELETION_FLAG_SET on class CL_RECA_ARCHIVING_OBJECT has no parameter.
Method CHECK_DELETION_FLAG_SET on class CL_RECA_ARCHIVING_OBJECT has no exception.

Method CHECK_RESIDENCE_TIME_1 Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ID_DBEAR	Value transfer	☐	Type reference (TYPE)	RUSER-DBEAR		Datum der letzten Bearbeitung	20030305
2	Importing	ID_DERF	Value transfer	☑	Type reference (TYPE)	RUSER-DERF		Datum der Ersterfassung	20030305

#	Exception	Resumable	Description	Created on
1	ERROR	☐	Residenzzeit noch nicht verstrichen	20030305

Method CHECK_RESIDENCE_TIME_2 Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ID_DBEAR	Value transfer	☐	Type reference (TYPE)	RUSER-DBEAR		Datum der letzten Bearbeitung	20030307
2	Importing	ID_DERF	Value transfer	☑	Type reference (TYPE)	RUSER-DERF		Datum der Ersterfassung	20030307

#	Exception	Resumable	Description	Created on
1	ERROR	☐	Residenzzeit noch nicht verstrichen	20030307

Method DELETE Signature

Method DELETE on class CL_RECA_ARCHIVING_OBJECT has no parameter.
Method DELETE on class CL_RECA_ARCHIVING_OBJECT has no exception.

Method DELETE_WITHOUT_ARCHIVING Signature

Method DELETE_WITHOUT_ARCHIVING on class CL_RECA_ARCHIVING_OBJECT has no parameter.
Method DELETE_WITHOUT_ARCHIVING on class CL_RECA_ARCHIVING_OBJECT has no exception.

Method GET_PROPERTIES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ED_HELPDOC_ARCHIVE	Call by reference	☐	Type reference (TYPE)	DOKHL-OBJECT		Doku-Objekt über Voraussetzungen zum Archivieren	20030108
2	Exporting	ED_HELPDOC_DELETE	Call by reference	☐	Type reference (TYPE)	DOKHL-OBJECT		Doku-Objekt über Voraussetzungen zum Löschen	20030108
3	Exporting	EF_ARCLASS_CHANGEDOCU	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		Ist Archivierungsklasse für Änderungsbelege zu verwenden?	20030108
4	Exporting	EF_ARCLASS_CO_TOTAL	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		Ist Archivierungsklasse für CO-Summensätze zu verwenden?	20030405
5	Exporting	EF_ARCLASS_STATUS	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		Ist Archivierungsklasse für CO-Statusobjekte zu verwenden?	20030108
6	Exporting	EF_ARCLASS_TEXT	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		Ist Archivierungsklasse für SAPscript-Texte zu verwenden?	20030108
7	Exporting	EF_IS_BUSOBJ	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		Gilt das Arch.-objekt für ein vollständiges Business-Objekt?	20030108
8	Exporting	EF_MULTIPLE_AROBJKEY	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		Darf das gleiche Datenobjekt mehrfach archiviert sein?	20030318

Method GET_PROPERTIES on class CL_RECA_ARCHIVING_OBJECT has no exception.

Method GET_SELECTION_BY_AROBJKEY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ED_FIELDCAT	Call by reference	☐	Type reference (TYPE)	AIND_FCAT		Feldkatalog des Archivinformationssystems	20021129
2	Exporting	ETX_SELECTIONS	Call by reference	☐	Type reference (TYPE)	RSDS_FRANGE_T		Selektionsbedingungen für das Datenobjekt ID_AROBJKEY	20021129
3	Exporting	ET_OBLIGATORY_FIELDS	Call by reference	☐	Type reference (TYPE)	INDEX TABLE		Mussfelder in den Selektionsbedingungen	20021129
4	Importing	ID_AROBJKEY	Value transfer	☐	Type reference (TYPE)	RECAAROBJKEY		Schlüssel des archivierten Datenobjekts	20021129

Method GET_SELECTION_BY_AROBJKEY on class CL_RECA_ARCHIVING_OBJECT has no exception.

Method GET_STATUS_SUBOBJ_LIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_OBJNR	Call by reference	☐	Type reference (TYPE)	RE_T_OBJNR		Untergeordnete, zu löschende CO-Objekte	20030620
2	Importing	IO_BUSOBJ	Value transfer	☐	Object reference (TYPE REF TO)	IF_RECA_BUS_OBJECT		Business-Objekt	20030620

Method GET_STATUS_SUBOBJ_LIST on class CL_RECA_ARCHIVING_OBJECT has no exception.

Method GET_TEXT_LIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_TEXT_KEY	Call by reference	☐	Type reference (TYPE)	TSPSKEY		Schlüssel der zugehörigen SAPscript-Texte	20030109
2	Importing	IO_BUSOBJ	Value transfer	☐	Object reference (TYPE REF TO)	IF_RECA_BUS_OBJECT		Business-Objekt	20030109

Method GET_TEXT_LIST on class CL_RECA_ARCHIVING_OBJECT has no exception.

Method INIT Signature

Method INIT on class CL_RECA_ARCHIVING_OBJECT has no parameter.
Method INIT on class CL_RECA_ARCHIVING_OBJECT has no exception.

Method ME_CHECK_DELETE_WITHOUT_ARCH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_BUSOBJ	Value transfer	☑	Object reference (TYPE REF TO)	IF_RECA_BUS_OBJECT		Business-Objekt	20030319
2	Importing	IO_MSGLIST	Value transfer	☐	Object reference (TYPE REF TO)	IF_RECA_MESSAGE_LIST		Fehlerprotokoll	20030319
3	Importing	IO_OBJECT	Value transfer	☑	Object reference (TYPE REF TO)	OBJECT		Anderes Objekt	20130603

Method ME_CHECK_DELETE_WITHOUT_ARCH on class CL_RECA_ARCHIVING_OBJECT has no exception.

Method ME_CHECK_WRITE_ARCHIVE_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_HEADER_KEY	Call by reference	☐	Type reference (TYPE)	DATA		Schlüssel des zu archivierenden Datenobjektes	20030319

#	Exception	Resumable	Description	Created on
1	ERROR	☐	Datenobjekt ist nicht zu archivieren	20030319

Method ME_DELETE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ED_AROBJKEY	Call by reference	☐	Type reference (TYPE)	RECAAROBJKEY		Schlüssel des gelöschten Datenobjekts	20030319
2	Exporting	ES_AROBJINFO	Call by reference	☐	Type reference (TYPE)	RECA_AR_OBJ_INFO		Weitere Informationen zum gelöschten Datenobjekt	20030319
3	Exporting	ET_STATISTICS	Call by reference	☐	Type reference (TYPE)	RE_T_ARCH_STAT		Statistikdaten über gelöschte Datensätze	20030319
4	Importing	IF_MIGRATED_RECLASSIC	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20060706
5	Importing	IF_WITHOUT_ARCHIVE	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	' '=Daten aus dem Archiv; 'X'=direktes Löschen von DB-Daten	20030319
6	Importing	IS_HEADER_KEY	Call by reference	☑	Type reference (TYPE)	DATA		Schlüssel des Datenobjekts; nur für IF_WITHOUT_ARCHIVE='X'	20030319
7	Importing	IS_OPTIONS	Value transfer	☐	Type reference (TYPE)	RECA_AR_OPTIONS_DELETE		Archivierungsoptionen beim Löschen	20030319

#	Exception	Resumable	Description	Created on
1	ERROR	☐	Fehler	20030319

Method ME_READ_INTO_BUFFER Signature

Method ME_READ_INTO_BUFFER on class CL_RECA_ARCHIVING_OBJECT has no parameter.

#	Exception	Resumable	Description	Created on
1	ERROR	☐	Fehler beim Lesen	20030319

Method ME_WRITE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_HEADER_KEY	Call by reference	☐	Type reference (TYPE)	DATA		Schlüssel des zu archivierenden Datenobjektes	20030319

#	Exception	Resumable	Description	Created on
1	ERROR	☐	Fehler	20030319

Method READ_FROM_ARCHIVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ESX_DATA	Call by reference	☐	Type reference (TYPE)	DATA		Daten des Datenobjekts	20030107

#	Exception	Resumable	Description	Created on
1	ERROR	☐	Fehler	20030107

Method READ_FROM_DB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ESX_DATA	Call by reference	☐	Type reference (TYPE)	DATA		Daten des Datenobjekts	20030107
2	Importing	IS_HEADER_KEY	Call by reference	☐	Type reference (TYPE)	DATA		Schlüssel des Datenobjekts	20030107

#	Exception	Resumable	Description	Created on
1	ERROR	☐	Fehler	20030107

Method READ_INTO_BUFFER Signature

Method READ_INTO_BUFFER on class CL_RECA_ARCHIVING_OBJECT has no parameter.
Method READ_INTO_BUFFER on class CL_RECA_ARCHIVING_OBJECT has no exception.

Method SET_DELETION_IND Signature

Method SET_DELETION_IND on class CL_RECA_ARCHIVING_OBJECT has no parameter.
Method SET_DELETION_IND on class CL_RECA_ARCHIVING_OBJECT has no exception.

Method WRITE Signature

Method WRITE on class CL_RECA_ARCHIVING_OBJECT has no parameter.
Method WRITE on class CL_RECA_ARCHIVING_OBJECT has no exception.

Method _DELETE_ARCHIVE_CLOSE Signature

Method _DELETE_ARCHIVE_CLOSE on class CL_RECA_ARCHIVING_OBJECT has no parameter.

#	Exception	Resumable	Description	Created on
1	ERROR	☐	Fehler	20021126

Method _DELETE_ARCHIVE_OPEN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_OPTIONS	Call by reference	☐	Type reference (TYPE)	RECA_AR_OPTIONS_DELETE		Archivierungsoptionen	20021126

#	Exception	Resumable	Description	Created on
1	ERROR	☐	Fehler	20021126
2	NO_FILES_AVAILABLE	☐	Keine Datei vorhanden	20021206

Method _DELETE_DATA_ARCLASSES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IF_MIGRATED_RECLASSIC	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20060706
2	Importing	IF_WITHOUT_ARCHIVE	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	' '=Daten aus dem Archiv; 'X'=direktes Löschen von DB-Daten	20030107
3	Importing	IS_HEADER_KEY	Call by reference	☐	Type reference (TYPE)	DATA		Schlüssel des Datenobjekts; nur für IF_WITHOUT_ARCHIVE='X'	20030107
4	Importing	IS_OPTIONS	Value transfer	☐	Type reference (TYPE)	RECA_AR_OPTIONS_DELETE		Archivierungsoptionen beim Löschen	20030107

#	Exception	Resumable	Description	Created on
1	ERROR	☐	Fehler	20030107

Method _WRITE_ARCHIVE_CLOSE Signature

Method _WRITE_ARCHIVE_CLOSE on class CL_RECA_ARCHIVING_OBJECT has no parameter.

#	Exception	Resumable	Description	Created on
1	ERROR	☐	Fehler	20021126

Method _WRITE_ARCHIVE_DATA_ARCLASSES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_HEADER_KEY	Call by reference	☐	Type reference (TYPE)	DATA		Schlüssel des zu archivierenden Datenobjektes	20030107

#	Exception	Resumable	Description	Created on
1	ERROR	☐	Fehler	20030107

Method _WRITE_ARCHIVE_NEW_OBJECT Signature

Method _WRITE_ARCHIVE_NEW_OBJECT on class CL_RECA_ARCHIVING_OBJECT has no parameter.

#	Exception	Resumable	Description	Created on
1	ERROR	☐	Fehler	20021126

Method _WRITE_ARCHIVE_OPEN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_OPTIONS	Call by reference	☐	Type reference (TYPE)	RECA_AR_OPTIONS_WRITE		Archivierungsoptionen	20021125

#	Exception	Resumable	Description	Created on
1	ERROR	☐	Fehler	20021125

Method _WRITE_ARCHIVE_SAVE_OBJECT Signature

Method _WRITE_ARCHIVE_SAVE_OBJECT on class CL_RECA_ARCHIVING_OBJECT has no parameter.

#	Exception	Resumable	Description	Created on
1	ERROR	☐	Fehler	20021126
2	TERMINATION_REQUESTED	☐	Terminierung der Archivierung wurde verlangt	20021126

Event Signatures

Event AFTER_DELETE_BUSOBJ Signature
Event AFTER_DELETE_BUSOBJ on class CL_RECA_ARCHIVING_OBJECT has no parameter.
Event BEFORE_DELETE_BUSOBJ Signature
Event BEFORE_DELETE_BUSOBJ on class CL_RECA_ARCHIVING_OBJECT has no parameter.

History

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