SAP ABAP Class CL_CDOCS_ARCHIVING (CDOCS: Archiving Content)
Hierarchy
☛
CPRXRPM (Software Component) SAP Portfolio and Project Management 6.0
⤷
PLM-DOC (Application Component) Engineering Documents
⤷
EDMS_SKWF_LAYER (Package) EDMS: Communication with KPRO (SKWF)
CPRXRPM (Software Component) SAP Portfolio and Project Management 6.0⤷
PLM-DOC (Application Component) Engineering Documents⤷
EDMS_SKWF_LAYER (Package) EDMS: Communication with KPRO (SKWF)Properties
| Class | CL_CDOCS_ARCHIVING | |
| Short Description | CDOCS: Archiving Content | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | EDMS_SKWF_LAYER | EDMS: Communication with KPRO (SKWF) |
| Created | 20030602 | SAP |
| Last change | 20141109 | |
| 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 | ICON |
Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
Class CL_CDOCS_ARCHIVING has no interface implemented.
Friends
Class CL_CDOCS_ARCHIVING has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | GC_ARC_OBJ_CDOCS_CONT |
Constant | Public | Type reference (TYPE) | OBJCT_TR01 | 'CDOCS_CONT' | Archiving Object | 20130327 | |
| 2 | GC_ILM_ACTION_ARCHIVE |
Constant | Public | Type reference (TYPE) | GTY_ILM_ACTION | 'A' | 20130326 | ||
| 3 | GC_ILM_ACTION_DESTROY |
Constant | Public | Type reference (TYPE) | GTY_ILM_ACTION | 'D' | 20130326 | ||
| 4 | GC_ILM_ACTION_SNAPSHOT |
Constant | Public | Type reference (TYPE) | GTY_ILM_ACTION | 'S' | 20130326 | ||
| 5 | MT_ARCH_IDX |
Static Attribute | Private | Type reference (TYPE) | TT_ARCH_IDX | Archive index | 20030603 | ||
| 6 | MT_MESSAGES |
Static Attribute | Private | Type reference (TYPE) | TY_MESSAGES | Messages | 20030602 | ||
| 7 | MV_FOR_DESTRUCTION |
Static Attribute | Private | Type reference (TYPE) | FLAG | Indicator for Archiving Session for Data Destruction | 20130419 | ||
| 8 | MV_ILM_ACTION |
Static Attribute | Private | Type reference (TYPE) | GTY_ILM_ACTION | 20130327 | |||
| 9 | MV_TESTMODE |
Static Attribute | Private | Type reference (TYPE) | FLAG | Test Mode | 20030604 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | ADD_MESSAGE_TO_LOG |
Static method | Public | Method | Add Message to Log | 20030602 |
| 2 | COMMIT_DELETE |
Static method | Private | Method | Perform Commit Work for Deletion Program | 20030603 |
| 3 | DELETE |
Static method | Public | Method | Delete Projects from Database | 20030602 |
| 4 | DO_DELETE |
Static method | Private | Method | Perform Deletion | 20030603 |
| 5 | DO_WRITE |
Static method | Private | Method | Write Operation Execution | 20030602 |
| 6 | GET_ALL_CDOCS_LINK |
Static method | Public | Method | Get all document links | 20130515 |
| 7 | PRINT_LOG |
Static method | Private | Method | Issue Log in List | 20030602 |
| 8 | WRITE |
Static method | Public | Method | Write Files to Archive | 20030602 |
Events
Class CL_CDOCS_ARCHIVING has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | GTY_ILM_ACTION | Public | See coding | 20130326 | gty_ilm_action TYPE c LENGTH 1
|
||
| 2 | TT_ARCHIVE_NAME | Private | See coding | 20130326 | tt_archive_name TYPE STANDARD TABLE OF ty_archive_name
|
||
| 3 | TT_ARCH_IDX | Private | See coding | 20030603 | tt_arch_idx TYPE STANDARD TABLE OF cdocs_arch_idx
|
||
| 4 | TY_ARCHIVE_NAME | Private | See coding | 20130326 | BEGIN OF ty_archive_name,
archive_name TYPE arkey,
END OF ty_archive_name
|
||
| 5 | TY_MESSAGE | Private | See coding | 20030602 | BEGIN OF ty_message,
type TYPE symsgty,
text TYPE string,
END OF ty_message
|
||
| 6 | TY_MESSAGES | Private | See coding | 20030602 | ty_messages TYPE STANDARD TABLE OF ty_message
|
Method Signatures
Method ADD_MESSAGE_TO_LOG Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
IV_MSGID | Call by reference | Type reference (TYPE) | SYMSGID | Nachrichten, Nachrichtenklasse | 20030602 | ||
| 2 | Importing |
IV_MSGNO | Call by reference | Type reference (TYPE) | SYMSGNO | Nachrichten, Nachrichtennummer | 20030602 | ||
| 3 | Importing |
IV_MSGTY | Call by reference | Type reference (TYPE) | SYMSGTY | 'I' | Nachrichten, Nachrichtentyp | 20030602 | |
| 4 | Importing |
IV_MSGV1 | Call by reference | Type reference (TYPE) | SYMSGV | Nachrichten, Nachrichtenvariable | 20030602 | ||
| 5 | Importing |
IV_MSGV2 | Call by reference | Type reference (TYPE) | SYMSGV | Nachrichten, Nachrichtenvariable | 20030602 | ||
| 6 | Importing |
IV_MSGV3 | Call by reference | Type reference (TYPE) | SYMSGV | Nachrichten, Nachrichtenvariable | 20030602 | ||
| 7 | Importing |
IV_MSGV4 | Call by reference | Type reference (TYPE) | SYMSGV | Nachrichten, Nachrichtenvariable | 20030602 |
Method ADD_MESSAGE_TO_LOG on class CL_CDOCS_ARCHIVING has no exception.
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 | allgemeines flag | 20030603 |
Method COMMIT_DELETE on class CL_CDOCS_ARCHIVING has no exception.
Method DELETE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_TESTMODE | Call by reference | Type reference (TYPE) | BOOLE_D | 'X' | Testmodus | 20030602 |
Method DELETE on class CL_CDOCS_ARCHIVING has no exception.
Method DO_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 | Interne Tabellen, aktueller Zeilenindex | 20030603 | ||
| 2 | Importing |
IV_TESTRUN | Call by reference | Type reference (TYPE) | FLAG | allgemeines flag | 20030603 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  FAILED |
Fehler beim Lesen aus Archiv | 20030603 | |
| 2 | WRONG_ACCESS_TO_ARCHIVE |
Falscher Zugriff auf Archiv | 20030603 |
Method DO_WRITE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IS_FILE_IO | Call by reference | Type reference (TYPE) | CDOCS_ARCH_IO | CDOCS: Zu archivierende IOs | 20030604 | ||
| 2 | Importing |
IV_ARCHIVE_HANDLE | Call by reference | Type reference (TYPE) | SYTABIX | Archiv-Handle | 20030602 | ||
| 3 | Importing |
IV_ILM_ACTION | Call by reference | Type reference (TYPE) | GTY_ILM_ACTION | 20130326 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | ADK_INTERNAL_ERROR |
Interner ADK Fehler | 20030603 | |
| 2 | DATA_OBJECT_NOT_SAVED |
The Data Object was not Written to the Archive | 20130327 | |
| 3 | FAILED |
Fehler beim Schreiben ins Archiv | 20030603 | |
| 4 | REJECT_REQUESTED |
Abbruch des Archivierungsvorgangs von Applikation verlangt | 20030603 | |
| 5 | TERMINATION_REQUESTED |
Abbruch des Archivierungsvorgangs von ADK verlangt | 20030603 | |
| 6 | WRONG_ACCESS_TO_ARCHIVE |
Falscher Zugriff auf Archiv | 20030603 |
Method GET_ALL_CDOCS_LINK Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
ET_CDOCS_ARCH_IO | Call by reference | Type reference (TYPE) | CFX_TT_CDOCS_ARCH_IO | CDOCS: Liste of IOs to Be Archived | 20130515 |
Method GET_ALL_CDOCS_LINK on class CL_CDOCS_ARCHIVING has no exception.
Method PRINT_LOG Signature
Method PRINT_LOG on class CL_CDOCS_ARCHIVING has no parameter.
Method PRINT_LOG on class CL_CDOCS_ARCHIVING has no exception.
Method WRITE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
EV_ERROR_OCCURED | Call by reference | Type reference (TYPE) | FLAG | Es trat ein Fehler auf | 20030604 | ||
| 2 | Importing |
IT_FILE_IO | Call by reference | Type reference (TYPE) | CFX_TT_CDOCS_ARCH_IO | CDOCS: Liste von zu archivierenden IOs | 20030603 | ||
| 3 | Importing |
IV_COMMENTS | Call by reference | Type reference (TYPE) | ADMI_TEXT | Vermerk zum Archivierungslauf | 20030602 | ||
| 4 | Importing |
IV_DELETE_TESTMODE | Call by reference | Type reference (TYPE) | ARCH_DELETE_TESTMODE | Processing Options for Delete Program: Test Mode | 20130327 | ||
| 5 | Importing |
IV_ILM_ACTION | Call by reference | Type reference (TYPE) | GTY_ILM_ACTION | 20130326 | |||
| 6 | Importing |
IV_LOG_DETAIL | Call by reference | Type reference (TYPE) | ARCH_PROCESSING_OPTIONS-DETAIL_LOG | Archiving: Detail Log | 20130327 | ||
| 7 | Importing |
IV_LOG_OUTPUT | Call by reference | Type reference (TYPE) | ARCH_PROCESSING_OPTIONS-OBJ_PROT_OUTPUT | Archiving: Log Output | 20130327 | ||
| 8 | Importing |
IV_TESTMODE | Call by reference | Type reference (TYPE) | BOOLE_D | 'X' | Testmodus | 20030602 |
Method WRITE on class CL_CDOCS_ARCHIVING has no exception.
History
| Last changed by/on | SAP | 20141109 |
| SAP Release Created in | 300 |
