SAP ABAP Class CF_RECA_ARCHIVING_OBJECT (Archiving Object: Factory)
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 ArchivingMeta Relationship - Using
| # | Relationship type | Using | Short Description | Created on |
|---|---|---|---|---|
| 1 | Inheritance (c INHERITING FROM c_ref) | CF_RECA_OBJECT | Object That Can Be Instantiated: Factory | 20021125 |
Properties
| Class | CF_RECA_ARCHIVING_OBJECT | |
| Short Description | Archiving Object: Factory | |
| Super Class | CF_RECA_OBJECT | Object That Can Be Instantiated: Factory |
| Instantiability of a Class | 0 | Private |
| 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 | 20040819 | 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) |
Interfaces
Class CF_RECA_ARCHIVING_OBJECT has no interface implemented.
Friends
Class CF_RECA_ARCHIVING_OBJECT has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | MD_ARCHIVE_HANDLE_BUFFER |
Static Attribute | Public | Type reference (TYPE) | SY-TABIX | Pointer to Current Archiving Folder | 20030316 | ||
| 2 | MF_ANY_DATA_BUFFERED |
Static Attribute | Public | Type reference (TYPE) | ABAP_BOOL | At Least 1 Object Read from Archive => Table Buffer | 20021203 | ||
| 3 | MO_BUSOBJ_BUFFER |
Static Attribute | Public | Object reference (TYPE REF TO) | IF_RECA_BUS_OBJECT | Last Business Object Read | 20021229 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | ASSERT_SUPPORTED_ARCHIVING |
Static method | Public | Method | Checks If Archiving Object Released for Use | 20040502 |
| 2 | CHECK_DELETION_FLAG_DEL |
Static method | Public | Method | Checks If Resetting Delation Flag Is Allowed [final] | 20030705 |
| 3 | CHECK_DELETION_FLAG_SET |
Static method | Public | Method | Checks If Setting Delation Flag Is Allowed [final] | 20030705 |
| 4 | CLASS_CONSTRUCTOR |
Static method | Public | Constructor | CLASS_CONSTRUCTOR | 20021206 |
| 5 | FIND |
Static method | Public | Method | Gets Instance for Archiving Object | 20021125 |
| 6 | FIND_BY_BUSOBJ |
Static method | Public | Method | Gets Instance for Archiving Object via Business Object | 20030705 |
| 7 | HANDLE_BUFFER_RESET_ALL |
Static method | Protected | Event handling method | Resets MF_ANY_DATA_BUFFERED at RESET_ALL | 20021206 |
| 8 | IS_BUSOBJ_ARCHIVED |
Static method | Public | Method | Checks If Business Object Was Already Archived | 20030326 |
| 9 | IS_OBJ_ARCHIVED_BY_AROBJKEY |
Static method | Public | Method | Checks If Object Was Already Archived (AROBJKEY) | 20040506 |
| 10 | IS_OBJ_ARCHIVED_BY_GUID |
Static method | Public | Method | Checks If Object Was Already Archived (GUID) | 20040506 |
| 11 | READ_BUSOBJ_BY_BUSKEY |
Static method | Public | Method | Reads Bus. Object from Archive to Table Buffer (BUSKEY) | 20021229 |
| 12 | READ_BUSOBJ_BY_INTRENO |
Static method | Public | Method | Reads Bus. Object from Archive to Table Buffer (INTRENO) | 20021229 |
| 13 | READ_BUSOBJ_BY_OBJNR |
Static method | Public | Method | Reads Bus. Object from Archive to Table Buffer (OBJNR) | 20021229 |
| 14 | READ_DATA_BY_AROBJKEY |
Static method | Public | Method | Reads Data from Archive to Table Buffer (AROBJKEY) | 20030319 |
| 15 | READ_DATA_BY_GUID |
Static method | Public | Method | Reads Data from Archive to Table Buffer (GUID) | 20030319 |
| 16 | SET_ANY_DATA_BUFFERED |
Static method | Public | Method | Records That Archived Data Was Placed in Table Buffer | 20021206 |
| 17 | SET_ARCHIVE_HANDLE_BUFFER |
Static method | Public | Method | Records the Pointer to the Last Opened Archive File | 20030316 |
| 18 | SET_BUSOBJ_BUFFER |
Static method | Public | Method | Records the Last Business Object Read from the Archive | 20021229 |
| 19 | _READ_BUSOBJ |
Static method | Private | Method | Reads Bus. Object from Archive to Table Buffer | 20021229 |
| 20 | _READ_DATA |
Static method | Private | Method | Reads Data from Archive to Table Buffer | 20030319 |
Events
Class CF_RECA_ARCHIVING_OBJECT has no event.
Types
Class CF_RECA_ARCHIVING_OBJECT has no local type.
Method Signatures
Method ASSERT_SUPPORTED_ARCHIVING 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 | 20040502 |
Method ASSERT_SUPPORTED_ARCHIVING on class CF_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? | 20030705 | ||
| 2 | Importing |
IO_BUSOBJ | Value transfer | Object reference (TYPE REF TO) | IF_RECA_BUS_OBJECT | Business-Objekt | 20030705 | ||
| 3 | Importing |
IO_MSGLIST | Value transfer | Object reference (TYPE REF TO) | IF_RECA_MESSAGE_LIST | Fehlerprotokoll | 20030705 |
Method CHECK_DELETION_FLAG_DEL on class CF_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? | 20030705 | ||
| 2 | Importing |
IO_BUSOBJ | Value transfer | Object reference (TYPE REF TO) | IF_RECA_BUS_OBJECT | Business-Objekt | 20030705 | ||
| 3 | Importing |
IO_MSGLIST | Value transfer | Object reference (TYPE REF TO) | IF_RECA_MESSAGE_LIST | Fehlerprotokoll | 20030705 |
Method CHECK_DELETION_FLAG_SET on class CF_RECA_ARCHIVING_OBJECT has no exception.
Method CLASS_CONSTRUCTOR Signature
Method CLASS_CONSTRUCTOR on class CF_RECA_ARCHIVING_OBJECT has no parameter.
Method CLASS_CONSTRUCTOR on class CF_RECA_ARCHIVING_OBJECT has no exception.
Method FIND 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 | ||
| 2 |  Returning |
RO_INSTANCE | Value transfer | Object reference (TYPE REF TO) | IF_RECA_ARCHIVING_OBJECT | Archivierungsobjekt | 20021125 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  ERROR |
Fehler | 20021125 |
Method FIND_BY_BUSOBJ 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 | 20030705 | ||
| 2 | Returning |
RO_INSTANCE | Value transfer | Object reference (TYPE REF TO) | IF_RECA_ARCHIVING_OBJECT | Archivierungsobjekt | 20030705 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | ERROR |
Fehler | 20030705 |
Method HANDLE_BUFFER_RESET_ALL Signature
Method HANDLE_BUFFER_RESET_ALL on class CF_RECA_ARCHIVING_OBJECT has no parameter.
Method HANDLE_BUFFER_RESET_ALL on class CF_RECA_ARCHIVING_OBJECT has no exception.
Method IS_BUSOBJ_ARCHIVED Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
ID_BUSKEY | Value transfer | Type reference (TYPE) | RECA1_BUSKEY | BOR-Objektschlüssel | 20030326 | ||
| 2 | Importing |
ID_BUSTYPE | Value transfer | Type reference (TYPE) | RECA1_BUSTYPE | BOR-Objekttyp (statt Objektart) | 20030326 | ||
| 3 | Importing |
ID_OBJTYPE | Value transfer | Type reference (TYPE) | RECAOBJTYPE | Objektart (statt BOR-Objekttyp) | 20030326 | ||
| 4 | Returning |
RF_ARCHIVED | Value transfer | Type reference (TYPE) | ABAP_BOOL | Business-Objekt wurde bereits archiviert | 20030326 |
Method IS_BUSOBJ_ARCHIVED on class CF_RECA_ARCHIVING_OBJECT has no exception.
Method IS_OBJ_ARCHIVED_BY_AROBJKEY 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 | 20040506 | ||
| 2 | Importing |
ID_AROBJTYPE | Value transfer | Type reference (TYPE) | RECAAROBJTYPE | Typ des archivierten Datenobjekts | 20040506 | ||
| 3 | Returning |
RF_ARCHIVED | Value transfer | Type reference (TYPE) | ABAP_BOOL | Objekt wurde bereits archiviert | 20040506 |
Method IS_OBJ_ARCHIVED_BY_AROBJKEY on class CF_RECA_ARCHIVING_OBJECT has no exception.
Method IS_OBJ_ARCHIVED_BY_GUID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
ID_AROBJTYPE | Value transfer | Type reference (TYPE) | RECAAROBJTYPE | Typ des archivierten Datenobjekts | 20040506 | ||
| 2 | Importing |
ID_GUID | Value transfer | Type reference (TYPE) | RECAGUID | GUID | 20040506 | ||
| 3 | Returning |
RF_ARCHIVED | Value transfer | Type reference (TYPE) | ABAP_BOOL | Objekt wurde bereits archiviert | 20040506 |
Method IS_OBJ_ARCHIVED_BY_GUID on class CF_RECA_ARCHIVING_OBJECT has no exception.
Method READ_BUSOBJ_BY_BUSKEY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
ID_ACTIVITY | Value transfer | Type reference (TYPE) | RECA1_ACTIVITY | RECA1_ACTIVITY-DISPLAY | Aktivität: Ändern/Anzeigen | 20021229 | |
| 2 | Importing |
ID_BUSKEY | Value transfer | Type reference (TYPE) | RECA1_BUSKEY | BOR-Objektschlüssel | 20021229 | ||
| 3 | Importing |
ID_BUSTYPE | Value transfer | Type reference (TYPE) | RECA1_BUSTYPE | BOR-Objekttyp (statt Objektart) | 20021229 | ||
| 4 | Importing |
ID_IDENT_KEY | Value transfer | Type reference (TYPE) | CSEQUENCE | Transp. Schlüssel (z.B. "1000/123") für Fehlermeldungen | 20021229 | ||
| 5 | Importing |
ID_OBJTYPE | Value transfer | Type reference (TYPE) | RECAOBJTYPE | Objektart (statt BOR-Objekttyp) | 20021229 | ||
| 6 | Importing |
IF_USE_ARCHIVE | Value transfer | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | Aus Archiv lesen, falls nicht in DB vorhanden? | 20021229 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | ERROR |
Fehler | 20021229 |
Method READ_BUSOBJ_BY_INTRENO Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
ID_ACTIVITY | Value transfer | Type reference (TYPE) | RECA1_ACTIVITY | RECA1_ACTIVITY-DISPLAY | Aktivität: Ändern/Anzeigen | 20021229 | |
| 2 | Importing |
ID_IDENT_KEY | Value transfer | Type reference (TYPE) | CSEQUENCE | Transp. Schlüssel (z.B. "1000/123") für Fehlermeldungen | 20021229 | ||
| 3 | Importing |
ID_INTRENO | Value transfer | Type reference (TYPE) | RECAINTRENO | INTRENO | 20021229 | ||
| 4 | Importing |
IF_USE_ARCHIVE | Value transfer | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | Aus Archiv lesen, falls nicht in DB vorhanden? | 20021229 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | ERROR |
Fehler | 20021229 |
Method READ_BUSOBJ_BY_OBJNR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
ID_ACTIVITY | Value transfer | Type reference (TYPE) | RECA1_ACTIVITY | RECA1_ACTIVITY-DISPLAY | Aktivität: Ändern/Anzeigen | 20021229 | |
| 2 | Importing |
ID_IDENT_KEY | Value transfer | Type reference (TYPE) | CSEQUENCE | Transp. Schlüssel (z.B. "1000/123") für Fehlermeldungen | 20021229 | ||
| 3 | Importing |
ID_OBJNR | Value transfer | Type reference (TYPE) | RECAOBJNR | OBJNR | 20021229 | ||
| 4 | Importing |
IF_USE_ARCHIVE | Value transfer | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | Aus Archiv lesen, falls nicht in DB vorhanden? | 20021229 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | ERROR |
Fehler | 20021229 |
Method READ_DATA_BY_AROBJKEY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
ID_ACTIVITY | Value transfer | Type reference (TYPE) | RECA1_ACTIVITY | RECA1_ACTIVITY-DISPLAY | Aktivität: Ändern/Anzeigen | 20030319 | |
| 2 | Importing |
ID_AROBJKEY | Value transfer | Type reference (TYPE) | RECAAROBJKEY | Schlüssel des archivierten Datenobjekts | 20030319 | ||
| 3 | Importing |
ID_AROBJTYPE | Value transfer | Type reference (TYPE) | RECAAROBJTYPE | Typ des archivierten Datenobjekts | 20030319 | ||
| 4 | Importing |
ID_IDENT_KEY | Value transfer | Type reference (TYPE) | CSEQUENCE | Transp. Schlüssel (z.B. "1000/123") für Fehlermeldungen | 20030319 | ||
| 5 | Importing |
IF_USE_ARCHIVE | Value transfer | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | Aus Archiv lesen, falls nicht in DB vorhanden? | 20030319 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | ERROR |
Fehler | 20030319 |
Method READ_DATA_BY_GUID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
ID_ACTIVITY | Value transfer | Type reference (TYPE) | RECA1_ACTIVITY | RECA1_ACTIVITY-DISPLAY | Aktivität: Ändern/Anzeigen | 20030319 | |
| 2 | Importing |
ID_AROBJTYPE | Value transfer | Type reference (TYPE) | RECAAROBJTYPE | Typ des archivierten Datenobjekts | 20030319 | ||
| 3 | Importing |
ID_GUID | Value transfer | Type reference (TYPE) | RECAGUID | GUID | 20030319 | ||
| 4 | Importing |
ID_IDENT_KEY | Value transfer | Type reference (TYPE) | CSEQUENCE | Transp. Schlüssel (z.B. "1000/123") für Fehlermeldungen | 20030319 | ||
| 5 | Importing |
IF_USE_ARCHIVE | Value transfer | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | Aus Archiv lesen, falls nicht in DB vorhanden? | 20030319 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | ERROR |
Fehler | 20030319 |
Method SET_ANY_DATA_BUFFERED Signature
Method SET_ANY_DATA_BUFFERED on class CF_RECA_ARCHIVING_OBJECT has no parameter.
Method SET_ANY_DATA_BUFFERED on class CF_RECA_ARCHIVING_OBJECT has no exception.
Method SET_ARCHIVE_HANDLE_BUFFER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
ID_ARCHIVE_HANDLE | Value transfer | Type reference (TYPE) | SY-TABIX | Zeiger auf Archivdatei | 20030316 |
Method SET_ARCHIVE_HANDLE_BUFFER on class CF_RECA_ARCHIVING_OBJECT has no exception.
Method SET_BUSOBJ_BUFFER 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 | 20021229 |
Method SET_BUSOBJ_BUFFER on class CF_RECA_ARCHIVING_OBJECT has no exception.
Method _READ_BUSOBJ Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
ID_ACTIVITY | Call by reference | Type reference (TYPE) | RECA1_ACTIVITY | Aktivität: Ändern/Anzeigen | 20021229 | ||
| 2 | Importing |
ID_AROBJTYPE | Call by reference | Type reference (TYPE) | RECAAROBJTYPE | Typ des archivierten Datenobjekts | 20021229 | ||
| 3 | Importing |
ID_IDENT_KEY | Call by reference | Type reference (TYPE) | CSEQUENCE | Transp. Schlüssel (z.B. "1000/123") für Fehlermeldungen | 20021229 | ||
| 4 | Importing |
ID_XLOBJTYPE | Call by reference | Type reference (TYPE) | RECAXLOBJTYPE | Bezeichnung Objektart (20) | 20021229 | ||
| 5 | Importing |
IF_USE_ARCHIVE | Call by reference | Type reference (TYPE) | ABAP_BOOL | Aus Archiv lesen, falls nicht in DB vorhanden? | 20021229 | ||
| 6 | Importing |
IT_VICAAROBJ | Call by reference | Type reference (TYPE) | RE_T_VICAAROBJ | Archiviertes Immobilienobjekt (VICAAROBJ) | 20021229 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | ERROR |
Fehler | 20021229 |
Method _READ_DATA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
ID_ACTIVITY | Call by reference | Type reference (TYPE) | RECA1_ACTIVITY | Aktivität: Ändern/Anzeigen | 20030319 | ||
| 2 | Importing |
ID_AROBJTYPE | Call by reference | Type reference (TYPE) | RECAAROBJTYPE | Typ des archivierten Datenobjekts | 20030319 | ||
| 3 | Importing |
ID_IDENT_KEY | Call by reference | Type reference (TYPE) | CSEQUENCE | Transp. Schlüssel (z.B. "1000/123") für Fehlermeldungen | 20030319 | ||
| 4 | Importing |
IF_USE_ARCHIVE | Call by reference | Type reference (TYPE) | ABAP_BOOL | Aus Archiv lesen, falls nicht in DB vorhanden? | 20030319 | ||
| 5 | Importing |
IT_VICAAROBJ | Call by reference | Type reference (TYPE) | RE_T_VICAAROBJ | Archiviertes Datenobjekt (VICAAROBJ) | 20030319 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | ERROR |
Fehler | 20030319 |
History
| Last changed by/on | SAP | 20040819 |
| SAP Release Created in | 200 |
