SAP ABAP Interface IF_RECA_ARCHIVING_OBJECT (Archiving Object)
Hierarchy
☛
EA-FIN (Software Component) EA-FIN
⤷
RE-FX (Application Component) Flexible Real Estate Management
⤷
RE_CA_AR (Package) RE: Data Archiving
EA-FIN (Software Component) EA-FIN⤷
RE-FX (Application Component) Flexible Real Estate Management⤷
RE_CA_AR (Package) RE: Data Archiving
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | CL_RECA_ARCHIVING_OBJECT | Archiving Object (Abstract): Standard Implementation | 20021125 |
Properties
| Interface | IF_RECA_ARCHIVING_OBJECT | |
| Short Description | Archiving Object |
General Data
| Package | RE_CA_AR | RE: Data Archiving |
| Created | 20021121 | SAP |
| Last changed | 20140121 | SAP |
| 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) |
Interfaces
| # | Interface | Abstract | Final | Description | Created on |
|---|---|---|---|---|---|
| 1 | IF_RECA_OBJECT | Instantiable Object | 20021206 |
Friends
Interface IF_RECA_ARCHIVING_OBJECT has no friend.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | MD_NAME | Instance attribute | Public | Type reference (TYPE) | OBJCT_TR01 | Archiving Object Name | 20021125 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | CHECK_DELETE_WITHOUT_ARCHIVING |
Instance method | Public | Method | Checks If Deletion Without Archiving Is Allowed [Default] | 20021227 |
| 2 | CHECK_DELETION_FLAG_DEL |
Instance method | Public | Method | Checks If Resetting Deletion Flag Is Allowed [Default] | 20030622 |
| 3 | CHECK_DELETION_FLAG_SET |
Instance method | Public | Method | Checks If Setting Delation Flag Is Allowed [Default] | 20030622 |
| 4 | DELETE |
Instance method | Public | Method | Deletes Data from DB that Exists in Archive [final] | 20021126 |
| 5 | DELETE_WITHOUT_ARCHIVING |
Instance method | Public | Method | Deletes Entire Business Object Without Archiving [final] | 20021227 |
| 6 | INIT |
Instance method | Public | Method | 20021125 | |
| 7 | READ_INTO_BUFFER |
Instance method | Public | Method | Reads Exactly One Data Object from the Archive [final] | 20021129 |
| 8 | SET_DELETION_IND |
Instance method | Public | Method | Sets the Deletion Indicator for the Data Objects [Abstract] | 20030622 |
| 9 | WRITE |
Instance method | Public | Method | Writes Data Objects to the Archive [final] | 20021125 |
Events
| # | Event | Type | Visibility | Description | Created on |
|---|---|---|---|---|---|
| 1 | AFTER_DELETE_BUSOBJ | Instance Event (0) |
Public (2) |
After Deletion of Business Object (Without Archiving) | 20030620 |
| 2 | BEFORE_DELETE_BUSOBJ | Instance Event (0) |
Public (2) |
Before Deletion of Business Object (Without Archiving) | 20030620 |
Types
Interface IF_RECA_ARCHIVING_OBJECT has no local type.
Method Signatures
Method CHECK_DELETE_WITHOUT_ARCHIVING Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
ED_HELPDOC | Call by reference | Type reference (TYPE) | DOKHL-OBJECT | Doku-Objekt über Voraussetzungen zum Löschen | 20030108 | ||
| 2 | Exporting |
EF_ALLOWED | Call by reference | Type reference (TYPE) | ABAP_BOOL | Löschen des Objekts zulässig? | 20021227 | ||
| 3 |  Importing |
IF_FORCE_DELETION | Value transfer | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Löschen erzwingen | 20050304 | |
| 4 | Importing |
IO_BUSOBJ | Value transfer | Object reference (TYPE REF TO) | IF_RECA_BUS_OBJECT | Business-Objekt | 20021227 | ||
| 5 | Importing |
IO_MSGLIST | Value transfer | Object reference (TYPE REF TO) | IF_RECA_MESSAGE_LIST | Fehlerprotokoll | 20021227 | ||
| 6 | Importing |
IO_OBJECT | Value transfer | Object reference (TYPE REF TO) | OBJECT | Anderes Objekt | 20130603 |
Method CHECK_DELETE_WITHOUT_ARCHIVING on Interface IF_RECA_ARCHIVING_OBJECT has no exception.
Method CHECK_DELETION_FLAG_DEL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
EF_ALLOWED | Call by reference | Type reference (TYPE) | ABAP_BOOL | Rücksetzen der Löschvormerkung zulässig? | 20030622 | ||
| 2 | Importing |
IO_BUSOBJ | Value transfer | Object reference (TYPE REF TO) | IF_RECA_BUS_OBJECT | Business-Objekt | 20030622 | ||
| 3 | Importing |
IO_MSGLIST | Value transfer | Object reference (TYPE REF TO) | IF_RECA_MESSAGE_LIST | Fehlerprotokoll | 20030622 |
Method CHECK_DELETION_FLAG_DEL on Interface IF_RECA_ARCHIVING_OBJECT has no exception.
Method CHECK_DELETION_FLAG_SET Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
EF_ALLOWED | Call by reference | Type reference (TYPE) | ABAP_BOOL | Setzen der Löschvormerkung zulässig? | 20030622 | ||
| 2 | Importing |
IO_BUSOBJ | Value transfer | Object reference (TYPE REF TO) | IF_RECA_BUS_OBJECT | Business-Objekt | 20030622 | ||
| 3 | Importing |
IO_MSGLIST | Value transfer | Object reference (TYPE REF TO) | IF_RECA_MESSAGE_LIST | Fehlerprotokoll | 20030622 |
Method CHECK_DELETION_FLAG_SET on Interface IF_RECA_ARCHIVING_OBJECT has no exception.
Method DELETE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IF_COMMIT | Value transfer | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | Führt COMMIT WORK in der Methode aus | 20021126 | |
| 2 | Importing |
IO_MSGLIST | Value transfer | Object reference (TYPE REF TO) | IF_RECA_MESSAGE_LIST | Fehlerprotokoll | 20021126 | ||
| 3 | Importing |
IS_OPTIONS | Value transfer | Type reference (TYPE) | RECA_AR_OPTIONS_DELETE | Archivierungsoptionen | 20021126 |
Method DELETE on Interface IF_RECA_ARCHIVING_OBJECT has no exception.
Method DELETE_WITHOUT_ARCHIVING Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ES_INFO_MSG | Call by reference | Type reference (TYPE) | RECASYMSG | Meldung nach erfolgreichem Löschen | 20021227 | ||
| 2 | Importing |
IF_COMMIT | Value transfer | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | COMMIT WORK in der Methode ausführen | 20021227 | |
| 3 | Importing |
IF_FORCE_DELETION | Value transfer | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Löschen erzwingen | 20050304 | |
| 4 | Importing |
IF_MIGRATED_RECLASSIC | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | 20060706 | ||
| 5 | Importing |
IF_RESET_BUFFER | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | Puffer zurücksetzen | 20131022 | |
| 6 | Importing |
IO_BUSOBJ | Value transfer | Object reference (TYPE REF TO) | IF_RECA_BUS_OBJECT | Business-Objekt | 20021227 | ||
| 7 | Importing |
IO_OBJECT | Value transfer | Object reference (TYPE REF TO) | OBJECT | Anderes Objekt | 20130603 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  ERROR |
Fehler beim Löschen des Objekts | 20021227 |
Method INIT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
ID_NAME | Value transfer | Type reference (TYPE) | OBJCT_TR01 | Name des Archivierungsobjektes | 20021125 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | ERROR |
Fehler | 20021125 |
Method READ_INTO_BUFFER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
ID_AROBJKEY | Value transfer | Type reference (TYPE) | RECAAROBJKEY | Schlüssel des archivierten Datenobjekts | 20021129 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | ERROR |
Fehler beim Lesen | 20021129 |
Method SET_DELETION_IND Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IF_COMMIT | Value transfer | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | Führt COMMIT WORK in der Methode aus | 20030622 | |
| 2 | Importing |
IO_MSGLIST | Value transfer | Object reference (TYPE REF TO) | IF_RECA_MESSAGE_LIST | Fehlerprotokoll | 20030622 | ||
| 3 | Importing |
IS_OPTIONS | Value transfer | Type reference (TYPE) | RECA_AR_OPTIONS_PREPARE | Archivierungsoptionen beim Vorlauf | 20030622 | ||
| 4 | Importing |
IS_OPTIONS_SPEC | Call by reference | Type reference (TYPE) | DATA | Spezifische Optionen (z.B. zur Selektion abhängiger Daten) | 20030622 | ||
| 5 | Importing |
IT_HEADER_KEY | Call by reference | Type reference (TYPE) | INDEX TABLE | Schlüssel der zu archivierenden Datenobjekte | 20030622 |
Method SET_DELETION_IND on Interface IF_RECA_ARCHIVING_OBJECT has no exception.
Method WRITE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IO_MSGLIST | Value transfer | Object reference (TYPE REF TO) | IF_RECA_MESSAGE_LIST | Fehlerprotokoll | 20021126 | ||
| 2 | Importing |
IS_OPTIONS | Value transfer | Type reference (TYPE) | RECA_AR_OPTIONS_WRITE | Archivierungsoptionen | 20021125 | ||
| 3 | Importing |
IT_HEADER_KEY | Call by reference | Type reference (TYPE) | INDEX TABLE | Schlüssel der zu archivierenden Datenobjekte | 20021126 |
Method WRITE on Interface IF_RECA_ARCHIVING_OBJECT has no exception.
Event Signatures
Event AFTER_DELETE_BUSOBJ Signature
| # | Parameter | Type | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IO_BUSOBJ | Exporting | Value transfer | Object reference (TYPE REF TO) | IF_RECA_BUS_OBJECT | Business-Objekt | 20030620 | ||
| 2 | IO_OBJECT | Exporting | Value transfer | Object reference (TYPE REF TO) | OBJECT | Anderes Objekt | 20130603 |
Event BEFORE_DELETE_BUSOBJ Signature
| # | Parameter | Type | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IO_BUSOBJ | Exporting | Value transfer | Object reference (TYPE REF TO) | IF_RECA_BUS_OBJECT | Business-Objekt | 20030620 | ||
| 2 | IO_MSGLIST | Exporting | Value transfer | Object reference (TYPE REF TO) | IF_RECA_MESSAGE_LIST | Nachrichtensammler (E-Meldung verhindert das Löschen) | 20030620 |
History
| Last changed by/on | SAP | 20140121 |
| SAP Release Created in | 200 |
