SAP ABAP Class IF_CMX_XS_ARCHIVE_MANAGER (XSteps: Archive Manager)
Properties
| Class | IF_CMX_XS_ARCHIVE_MANAGER | |
| Short Description | XSteps: Archive Manager | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | ||
| Created | 20021001 | SAP |
| Last change | 20040127 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
Class IF_CMX_XS_ARCHIVE_MANAGER has no forward declaration.
Interfaces
Class IF_CMX_XS_ARCHIVE_MANAGER has no interface implemented.
Friends
Class IF_CMX_XS_ARCHIVE_MANAGER has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CO_HANDLE_TYPE_CLOG |
Constant | Public | Type reference (TYPE) | CHAR1 | 'C' | Handle Type for CLOG | 20030414 | |
| 2 | CO_HANDLE_TYPE_URI |
Constant | Public | Type reference (TYPE) | CHAR1 | 'U' | Handle Type for URIs | 20030414 | |
| 3 | CO_INDEX_STATE_ACTIVE |
Constant | Public | Type reference (TYPE) | CMX_XS_ARCHIVE_INDEX_STATE | 'A' | XSteps: Status of a Property Index | 20030522 | |
| 4 | CO_INDEX_STATE_INACTIVE |
Constant | Public | Type reference (TYPE) | CMX_XS_ARCHIVE_INDEX_STATE | ' ' | XSteps: Status of a Property Index | 20030522 | |
| 5 | CO_PROP_ORIGIN_CHANGE |
Constant | Public | Type reference (TYPE) | CMX_XS_ARCHIVE_PROP_ORIGIN | 'C' | XSteps: Origin of a Value in the Property Index | 20030603 | |
| 6 | CO_PROP_ORIGIN_CONTEXT |
Constant | Public | Type reference (TYPE) | CMX_XS_ARCHIVE_PROP_ORIGIN | 'A' | XSteps: Origin of a Value in the Property Index | 20030523 | |
| 7 | CO_PROP_ORIGIN_META |
Constant | Public | Type reference (TYPE) | CMX_XS_ARCHIVE_PROP_ORIGIN | 'M' | XSteps: Origin of a Value in the Property Index | 20030523 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | CHECK_PROPERTY_DOMAIN |
Instance method | Public | Method | Checks a Domain for Usage in the Property Index | 20031030 |
| 2 | DELETE |
Instance method | Public | Method | Deletes Archived Trees from the Database | 20030325 |
| 3 | GET_CLOG |
Instance method | Public | Method | Loads Attributes and Addresses from the Change Logs | 20030411 |
| 4 | GET_CLOG_DOCUMENT |
Instance method | Public | Method | Loads a CLOG for a Handle | 20030414 |
| 5 | GET_DOCUMENT |
Instance method | Public | Method | Loads an XML Document for a URI | 20030411 |
| 6 | GET_ITEMS |
Instance method | Public | Method | Loads Tree Attribute from the Archive | 20030411 |
| 7 | GET_ROOTS |
Instance method | Public | Method | Loads a Tree from the Archive | 20030411 |
| 8 | MARK_FOR_ARCHIVE |
Instance method | Public | Method | Selects Persistent Trees for Archiving | 20030313 |
| 9 | WRITE_TO_ARCHIVE |
Instance method | Public | Method | Writes the Trees Marked for Archiving to the Archive | 20030321 |
Events
Class IF_CMX_XS_ARCHIVE_MANAGER has no event.
Types
Class IF_CMX_XS_ARCHIVE_MANAGER has no local type.
Method Signatures
Method CHECK_PROPERTY_DOMAIN Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
DOMNAME | Call by reference | Type reference (TYPE) | CMX_TYPES_DOMAIN_NAME | Name der Domäne | 20031030 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CX_CMX_XS_EXCEPTION |
XSteps: Ausnahme | 20031030 |
Method DELETE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
PRODUCTIV | Call by reference | Type reference (TYPE) | BOOLEAN | SPACE | boolsche Variable (X=true, -=false, space=unknown) | 20030411 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_CMX_XS_EXCEPTION |
XSteps: Ausnahme | 20030404 |
Method GET_CLOG Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
CRITERIA | Call by reference | Type reference (TYPE) | CMX_XS_W_CLOG_ITEM | XSteps: Handle für Änderungsprotokolle | 20030414 | ||
| 2 |  Returning |
RESULT | Value transfer | Type reference (TYPE) | CMX_XS_T_CLOG | XSteps: Änderungsprotokolle | 20030414 | ||
| 3 | Importing |
SKIP_INITIAL | Call by reference | Type reference (TYPE) | BOOLE_D | Datenelement zur Domäne BOOLE: TRUE (='X') und FALSE (=' ') | 20030521 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_CMX_XS_EXCEPTION |
XSteps: Ausnahme | 20030411 |
Method GET_CLOG_DOCUMENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
HANDLE | Call by reference | Type reference (TYPE) | CMX_XS_W_CLOG_HANDLE | URI einer Ressource oder Kollektion | 20030414 | ||
| 2 | Returning |
XML | Value transfer | Type reference (TYPE) | XSTRING | XML Dokument | 20030414 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_CMX_XS_EXCEPTION |
XSteps: Ausnahme | 20030414 |
Method GET_DOCUMENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
URI | Call by reference | Type reference (TYPE) | ADMI_URI | URI einer Ressource oder Kollektion | 20030414 | ||
| 2 | Returning |
XML | Value transfer | Type reference (TYPE) | XSTRING | XML Dokument | 20030414 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_CMX_XS_EXCEPTION |
XSteps: Ausnahme | 20030414 |
Method GET_ITEMS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
ITEMS | Value transfer | Type reference (TYPE) | CMX_XS_T_ARCHIVE_ITEM | XSteps: Struktur zur Beschreibung eines Archiveintrags | 20030411 | ||
| 2 | Importing |
REQUEST | Call by reference | Type reference (TYPE) | CMX_XS_W_ARCHIVE_ITEM | XSteps: Daten für einen Archivzugriff | 20030414 | ||
| 3 | Importing |
SKIP_INITIAL | Call by reference | Type reference (TYPE) | BOOLE_D | Datenelement zur Domäne BOOLE: TRUE (='X') und FALSE (=' ') | 20030521 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_CMX_XS_EXCEPTION |
XSteps: Ausnahme | 20030411 |
Method GET_ROOTS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
REQUEST | Call by reference | Type reference (TYPE) | CMX_XS_W_ARCHIVE_ITEM | XSteps: Daten für einen Archivzugriff | 20030414 | ||
| 2 | Returning |
ROOTS | Value transfer | Type reference (TYPE) | CMX_XS_T_ROOT | XSteps: Tabelle von Roots | 20030411 | ||
| 3 | Importing |
SKIP_INITIAL | Call by reference | Type reference (TYPE) | BOOLE_D | Datenelement zur Domäne BOOLE: TRUE (='X') und FALSE (=' ') | 20030521 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_CMX_XS_EXCEPTION |
XSteps: Ausnahme | 20030411 |
Method MARK_FOR_ARCHIVE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
NIDS | Call by reference | Type reference (TYPE) | CMX_XS_T_NODE_GUID | XSteps: Tabelle von Knoten-Schlüsseln | 20030326 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_CMX_XS_EXCEPTION |
XSteps: Ausnahme | 20030404 |
Method WRITE_TO_ARCHIVE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
APPLICATION | Call by reference | Type reference (TYPE) | CMX_XS_APPLICATION | XSteps: Anwendung | 20030325 | ||
| 2 | Importing |
AUTO_START_DELETION | Call by reference | Type reference (TYPE) | ARCH_DEL | 'X' | Automatischer Start des Löschprogramms | 20030325 | |
| 3 | Importing |
CHECK_XML | Call by reference | Type reference (TYPE) | ADMI_CHKL | 'NO' | Prüfung ('NO', 'PARSE' oder 'VALIDATE') | 20030321 | |
| 4 | Importing |
CHECK_XSD | Call by reference | Type reference (TYPE) | ADMI_CHKL | 'NO' | Prüfung ('NO', 'PARSE' oder 'VALIDATE') | 20030321 | |
| 5 | Importing |
COMMENT | Call by reference | Type reference (TYPE) | ADMI_TEXT | Vermerk zum Archivierungslauf | 20030325 | ||
| 6 | Importing |
STORE_RESOURCES | Call by reference | Type reference (TYPE) | ARCH_WRITE_TESTMODE | 'X' | Ablaufsteuerung im Schreibprogramm: Testmodus | 20030325 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_CMX_XS_EXCEPTION |
XSteps: Ausnahme | 20030325 |
History
| Last changed by/on | SAP | 20040127 |
| SAP Release Created in |
