SAP ABAP Class CL_CGPL_ARCHIVING (Project Planning - Archiving)

Hierarchy

☛ SAP_ABA (Software Component) Cross-Application Component
   ⤷ CA-GTF-GPL (Application Component) Generic Project Planning
     ⤷ CGPL_GENERIC_FUNCTIONS (Package) Project Planning - General Functions

Properties

Class	CL_CGPL_ARCHIVING
Short Description	Project Planning - Archiving
Super Class
Instantiability of a Class	0	Private
Final	☑

General Data

Message Class
Program status
Category	0
Package	CGPL_GENERIC_FUNCTIONS	Project Planning - General Functions
Created	20021015	SAP
Last change	20131127	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	CGPLC	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_CGPL_ARCHIVING has no interface implemented.

Friends

Class CL_CGPL_ARCHIVING has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MR_OBJECT_MANAGER	Instance attribute	Public	☑	Object reference (TYPE REF TO)	CL_CGPL_OBJECT_MANAGER		Project Planning - Object Manager	20021015
2	MT_ARCH_IDX	Instance attribute	Private	☐	Type reference (TYPE)	TY_ARCH_PROJECTS		Project Planning: Index of Archived Projects	20021018
3	MV_APPLICATION	Instance attribute	Public	☑	Type reference (TYPE)	CGPL_APPLICATION_TYPE		Application in Project Planning	20021015
4	MV_REJECT_REQUESTED	Instance attribute	Private	☐	Type reference (TYPE)	FLAG		Cancelation of Write Operation Requested	20021031
5	ST_INSTANCES	Static Attribute	Private	☐	Type reference (TYPE)	TY_INSTANCES		Instances of Class per Application	20021015

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	COMMIT_DELETE	Instance method	Private	Method	Carry Out Commit Work for Deletion Program	20021018
2	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	20021015
3	DELETE	Instance method	Public	Method	Delete Archived Data from Database	20021017
4	DELETE_USING_ACTIVE_DATA_OBJ	Static method	Public	Method	Delete data of current archive data object from DB	20130409
5	GET_ARCHIVE_OBJECT_DATA	Instance method	Public	Method	Read Data of Current Archiving Object	20021017
6	GET_ARCHIVE_OBJECT_IDS	Instance method	Public	Method	Read IDs of Project/Tasks of Current Archiving Object	20021017
7	GET_INSTANCE	Static method	Public	Method	Determine Instance for Application	20021015
8	GET_SUBPROJECTS	Instance method	Private	Method	Determine Assigned Projects	20021016
9	INCLUDE_PROJ_IN_WRITE_HIER	Static method	Private	Method		20130528
10	REJECT_WRITE	Instance method	Public	Method	Cancel Write Operation	20021031
11	WRITE	Instance method	Public	Method	Write Project (Structure) to Archive	20021015
12	WRITE_ARCHIVE_INDEX	Static method	Private	Method	Collect Data for Archive Index	20021018
13	WRITE_INTO_ACTIVE_DATA_OBJ	Static method	Public	Method	Write project structure to current archive data object	20130409

Events

#	Event	Type	Visibility	Description	Created on
1	BEFORE_DELETE_OBJECT_DATA	Instance Event (0)	Public (2)	Time: Before Call of Function ARCHIVE_DELETE_OBJECT_DATA	20021017
2	BEFORE_SAVE_OBJECT	Instance Event (0)	Public (2)	Time: Before Call of Function ARCHIVE_SAVE_OBJECT	20021016

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	GTY_SR_OBJTYPE	Private	See coding			20130528	gty_sr_objtype TYPE LINE OF gty_tr_objtype
2	GTY_TR_OBJTYPE	Private	See coding			20130528	gty_tr_objtype TYPE RANGE OF cgpl_object_type
3	TY_ARCH_PROJECTS	Private	See coding			20021017	ty_arch_projects TYPE STANDARD TABLE OF cgpl_arch_idx WITH KEY guid
4	TY_CGPL_PROJECT_GUIDS	Private	See coding			20130528	ty_cgpl_project_guids TYPE STANDARD TABLE OF cgpl_guid16
5	TY_GUIDS	Private	See coding			20021016	ty_guids TYPE STANDARD TABLE OF cgpl_guid16 WITH NON-UNIQUE DEFAULT KEY
6	TY_INSTANCES	Private	See coding			20021015	ty_instances TYPE STANDARD TABLE OF REF TO cl_cgpl_archiving WITH NON-UNIQUE DEFAULT KEY

Method Signatures

Method COMMIT_DELETE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_TESTRUN	Call by reference	☐	Type reference (TYPE)	FLAG		Testlauf	20021018

Method COMMIT_DELETE on class CL_CGPL_ARCHIVING has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_APPLICATION_TYPE	Call by reference	☐	Type reference (TYPE)	CGPL_APPLICATION_TYPE		Applikation in der Projektplanung	20021015

#	Exception	Resumable	Description	Created on
1	EXISTS	☐	Instanz zur Applikation existiert bereits	20021015
2	FAILED	☐	Fehler bei der Instanzerzeugung	20021015

Method DELETE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ARCHIVE_HANDLE	Call by reference	☐	Type reference (TYPE)	SYTABIX		Archiv-Handle	20021017
2	Importing	IV_TESTRUN	Call by reference	☐	Type reference (TYPE)	FLAG		Testlauf	20021018

#	Exception	Resumable	Description	Created on
1	FAILED	☐	Fehler beim Lesen aus Archiv	20021017
2	WRONG_ACCESS_TO_ARCHIVE	☐	Falscher Zugriff auf Archiv	20021017

Method DELETE_USING_ACTIVE_DATA_OBJ Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_APPLICATION_TYPE	Call by reference	☐	Type reference (TYPE)	CGPL_APPLICATION_TYPE		Application in Project Planning	20130409
2	Importing	IV_ARCHIVE_HANDLE	Call by reference	☐	Type reference (TYPE)	SYTABIX		Archive Handle	20130409
3	Importing	IV_ARCHIVE_NAME	Call by reference	☑	Type reference (TYPE)	ARKEY		Schlüssel einer Archivdatei	20130409
4	Importing	IV_OBJECT_OFFSET	Call by reference	☑	Type reference (TYPE)	ADMI_OFFST		Offset des Datenobjekts in der Archivdatei	20130409

Method DELETE_USING_ACTIVE_DATA_OBJ on class CL_CGPL_ARCHIVING has no exception.

Method GET_ARCHIVE_OBJECT_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_HIERARCHY	Call by reference	☐	Type reference (TYPE)	CGPL_THIERARCHY		Hierarchieknoten des aktuellen Archiv-Objekts	20021017
2	Exporting	ET_PROJECT	Call by reference	☐	Type reference (TYPE)	CGPL_TPROJECT		Projekte des aktuellen Archiv-Objekts	20021017
3	Exporting	ET_R3_ATTRIBUT	Call by reference	☐	Type reference (TYPE)	CGPL_R3_ATTRIBUTES		R3-Attribute des aktuellen Archiv-Objekts	20021017
4	Exporting	ET_RELATION	Call by reference	☐	Type reference (TYPE)	CGPL_T_RELATIONS		Verknüpfungen des aktuellen Archiv-Objekts	20021017
5	Exporting	ET_TASK	Call by reference	☐	Type reference (TYPE)	CGPL_TTASK		Aufgaben des aktuellen Archiv-Objekts	20021017
6	Exporting	ET_TEXT	Call by reference	☐	Type reference (TYPE)	CGPL_T_TEXTS		Texte des aktuellen Archiv-Objekts	20021017
7	Importing	IV_ARCHIVE_HANDLE	Call by reference	☐	Type reference (TYPE)	SYTABIX		Archiv-Handle	20021017

Method GET_ARCHIVE_OBJECT_DATA on class CL_CGPL_ARCHIVING has no exception.

Method GET_ARCHIVE_OBJECT_IDS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_PROJECTS	Call by reference	☐	Type reference (TYPE)	CGPL_OBJECT_IDS		Projektplanung: Tabelle mit GUID-Feld	20021017
2	Exporting	ET_TASKS	Call by reference	☐	Type reference (TYPE)	CGPL_OBJECT_IDS		Projektplanung: Tabelle mit GUID-Feld	20021017
3	Importing	IV_ARCHIVE_HANDLE	Call by reference	☐	Type reference (TYPE)	SYTABIX		Archiv-Handle	20021017

Method GET_ARCHIVE_OBJECT_IDS on class CL_CGPL_ARCHIVING has no exception.

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ER_INSTANCE	Value transfer	☐	Object reference (TYPE REF TO)	CL_CGPL_ARCHIVING		Projektplanung - Archivierung	20021015
2	Importing	IV_APPLICATION_TYPE	Call by reference	☐	Type reference (TYPE)	CGPL_APPLICATION_TYPE		Applikation in der Projektplanung	20021015

#	Exception	Resumable	Description	Created on
1	FAILED	☐	Applikation unterstützt keine Archivierung	20021015

Method GET_SUBPROJECTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ARCHIVE_HANDLE	Call by reference	☐	Type reference (TYPE)	SYTABIX		Archiv-Handle	20021017
2	Returning	RT_SUBPROJECTS	Value transfer	☐	Type reference (TYPE)	TY_GUIDS		GUIDs zugeordneter Projekte	20021016

Method GET_SUBPROJECTS on class CL_CGPL_ARCHIVING has no exception.

Method INCLUDE_PROJ_IN_WRITE_HIER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	CT_INCLUDED	Call by reference	☐	Type reference (TYPE)	TY_CGPL_PROJECT_GUIDS			20130528
2	Importing	IT_EXCLUDED_OBJ_TYPE	Call by reference	☑	Type reference (TYPE)	CGPL_OBJECT_TYPES			20130528

Method INCLUDE_PROJ_IN_WRITE_HIER on class CL_CGPL_ARCHIVING has no exception.

Method REJECT_WRITE Signature

Method REJECT_WRITE on class CL_CGPL_ARCHIVING has no parameter.
Method REJECT_WRITE on class CL_CGPL_ARCHIVING has no exception.

Method WRITE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ARCHIVE_HANDLE	Call by reference	☐	Type reference (TYPE)	SYTABIX		Archiv-Handle	20021015
2	Importing	IV_PROJECT_GUID	Call by reference	☐	Type reference (TYPE)	CGPL_GUID16		Projektplanung: 16-stellige GUID für Projekte und Vorgänge	20021015

#	Exception	Resumable	Description	Created on
1	ADK_INTERNAL_ERROR	☐	Interner ADK Fehler	20021018
2	DATA_OBJECT_NOT_SAVED	☐	Das Datenobjekt wurde nicht ins Archiv geschrieben	20130218
3	FAILED	☐	Fehler beim Schreiben ins Archiv	20021017
4	REJECT_REQUESTED	☐	Abbruch des Archivierungsvorgangs von Applikation verlangt	20021031
5	TERMINATION_REQUESTED	☐	Abbruch des Archivierungsvorgangs von ADK verlangt	20021018
6	WRONG_ACCESS_TO_ARCHIVE	☐	Falscher Zugriff auf Archiv	20021017

Method WRITE_ARCHIVE_INDEX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_ARCH_IDX	Call by reference	☐	Type reference (TYPE)	TY_ARCH_PROJECTS		Projektplanung: Index archivierter Projekte	20130409
2	Importing	IV_APPLICATION_TYPE	Call by reference	☐	Type reference (TYPE)	CGPL_APPLICATION_TYPE		Applikation in der Projektplanung	20130409
3	Importing	IV_ARCHIVE_HANDLE	Call by reference	☐	Type reference (TYPE)	SYTABIX		Archiv-Handle	20021018
4	Importing	IV_ARCHIVE_NAME	Call by reference	☐	Type reference (TYPE)	ARKEY		Schlüssel einer Archivdatei	20021018
5	Importing	IV_DO_DB_MODIFY	Call by reference	☐	Type reference (TYPE)	BOOLE_D	ABAP_FALSE	Do Modify of DB	20130328
6	Importing	IV_OBJECT_OFFSET	Call by reference	☐	Type reference (TYPE)	ADMI_OFFST		Offset des Datenobjekts in der Archivdatei	20021018
7	Importing	IV_TESTRUN	Call by reference	☐	Type reference (TYPE)	FLAG		Testlauf	20021018

Method WRITE_ARCHIVE_INDEX on class CL_CGPL_ARCHIVING has no exception.

Method WRITE_INTO_ACTIVE_DATA_OBJ Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_EXCLUDED_OBJ_TYPE	Call by reference	☑	Type reference (TYPE)	CGPL_OBJECT_TYPES			20130528
2	Importing	IV_APPLICATION_TYPE	Call by reference	☐	Type reference (TYPE)	CGPL_APPLICATION_TYPE		Application in Project Planning	20130409
3	Importing	IV_ARCHIVE_HANDLE	Call by reference	☐	Type reference (TYPE)	SYTABIX		Archive Handle	20130409
4	Importing	IV_PROJECT_GUID	Call by reference	☐	Type reference (TYPE)	CGPL_GUID16		CGPL Project GUID	20130409

#	Exception	Resumable	Description	Created on
1	FAILED	☐	Application Does Not Support Archiving	20130409
2	WRONG_ACCESS_TO_ARCHIVE	☐	Incorrect Archive Access	20130409

Event Signatures

Event BEFORE_DELETE_OBJECT_DATA Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	EV_ARCHIVE_HANDLE	Exporting	Value transfer	☐	Type reference (TYPE)	SYTABIX		Archiv-Handle	20021018
2	EV_TESTRUN	Exporting	Value transfer	☐	Type reference (TYPE)	FLAG		Testlauf	20021018

Event BEFORE_SAVE_OBJECT Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	EV_ARCHIVE_HANDLE	Exporting	Value transfer	☐	Type reference (TYPE)	SYTABIX		Archiv-Handle	20021016
2	EV_PROJECT_GUID	Exporting	Value transfer	☐	Type reference (TYPE)	CGPL_GUID16		Projekt GUID	20021016

History

Last changed by/on	SAP	20131127
SAP Release Created in	630