Hierarchy
⤷
⤷
Properties
| Class | CL_XADK_API | |
| Short Description | XADK_API | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | BA | |
| Program status | ||
| Category | 0 | |
| Package | SARC | Archive Development Kit |
| Created | 20020902 | SAP |
| Last change | 20110908 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) | |
| 2 | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
Class CL_XADK_API has no interface implemented.
Friends
Class CL_XADK_API has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Constant | Public | Type reference (TYPE) | BOOLEAN | 'F' | 20021023 | |||
| 2 | Constant | Public | Type reference (TYPE) | BOOLEAN | 'T' | 20021023 | |||
| 3 | Static Attribute | Private | Type reference (TYPE) | CHAR1 | BOOLEAN_FALSE | Single-Character Flag | 20030214 | ||
| 4 | Static Attribute | Public | Type reference (TYPE) | CHAR1 | BOOLEAN_FALSE | Single-Character Indicator | 20031118 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Static method | Public | Method | Check Resources for XML Well-Formedness | 20021016 | |
| 2 | Static method | Public | Method | Syntax Check of the Path Extension Parameter | 20041110 | |
| 3 | Static method | Public | Method | Close Handle (and Archiving Session) | 20020902 | |
| 4 | Static method | Public | Method | Close Partition | 20020920 | |
| 5 | Static method | Public | Method | Confirm Deletion of Resources | 20020920 | |
| 6 | Static method | Public | Method | Delete Resources or Collections | 20021203 | |
| 7 | Static method | Public | Method | Freeze Collection | 20021203 | |
| 8 | Static method | Public | Method | Read Resources from Archive | 20020902 | |
| 9 | Static method | Public | Method | 20051220 | ||
| 10 | Static method | Public | Method | Read Customizing Information of an Archiving Object | 20020902 | |
| 11 | Static method | Public | Method | Transfer of Statistics Data | 20030115 | |
| 12 | Static method | Public | Method | Existence Check for Resources or Collections | 20021022 | |
| 13 | Static method | Public | Method | Information about the XML DAS and an Archive Path | 20021023 | |
| 14 | Static method | Public | Method | Display Resources List | 20020902 | |
| 15 | Static method | Public | Method | Create Collection | 20020902 | |
| 16 | Static method | Public | Method | Creation of One or More Collections | 20040510 | |
| 17 | Static method | Public | Method | Open Delete Handle | 20020903 | |
| 18 | Static method | Public | Method | Open Partition | 20020920 | |
| 19 | Static method | Public | Method | Open Read Handle | 20020902 | |
| 20 | Static method | Public | Method | Open Write Handle and Generate Archiving Session | 20020902 | |
| 21 | Static method | Public | Method | Pack Resources of a Collection | 20021212 | |
| 22 | Static method | Public | Method | Determine the Status of the Asynchronous PACK Process | 20030522 | |
| 23 | Static method | Public | Method | Make Resources of a Partition Available for Deletion | 20020920 | |
| 24 | Static method | Public | Method | Make Resources Available for Deletion | 20020919 | |
| 25 | Static method | Public | Method | Create Property Index | 20021202 | |
| 26 | Static method | Public | Method | Read Properties of a Property Index | 20030207 | |
| 27 | Static method | Public | Method | Delete Property Index | 20021203 | |
| 28 | Static method | Public | Method | Read Resource Properties From an Index | 20021212 | |
| 29 | Static method | Public | Method | Insert Resource Properties Into an Index | 20021202 | |
| 30 | Static method | Public | Method | List Property Indexes for an Archiving Object | 20030925 | |
| 31 | Static method | Public | Method | Write Resource Into Archive | 20020902 | |
| 32 | Static method | Public | Method | Deletion of Resource During Write in Case of Termination | 20030313 | |
| 33 | Static method | Public | Method | Select Resources | 20021010 | |
| 34 | Static method | Public | Method | Unpack the Resources of a Collection | 20030522 | |
| 35 | Static method | Public | Method | Check Sum Verification by Collection | 20050118 | |
| 36 | Static method | Public | Method | Output of Statistics | 20030428 | |
| 37 | Static method | Public | Method | Administration: Synchronize HOME Path | 20021218 |
Events
| # | Event | Type | Visibility | Description | Created on |
|---|---|---|---|---|---|
| 1 | INTERRUPTION_REQUESTED | Static Event (1) |
Public (2) |
Interruption Request Was Triggered | 20030722 |
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | BOOLEAN | Private | See coding | 20021023 | BOOLEAN(1) type C
|
||
| 2 | TS_SESSION | Public | See coding | 20051220 | BEGIN OF ts_session,
handle TYPE REF TO cl_xadk_api,
object TYPE objct_tr01,
document TYPE admi_run_d,
jobtype TYPE admi_job_t,
is_partitioned type boole_d,
current_number_of_objects TYPE i,
current_number_of_partitions TYPE i,
END OF ts_session
|
||
| 3 | TT_SESSIONS | Public | See coding | 20051220 | tt_sessions TYPE STANDARD TABLE OF ts_session WITH DEFAULT KEY
|
Method Signatures
Method CHECK Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CHECK_LEVEL | Call by reference | Type reference (TYPE) | ADMI_CHKL | Prüfung ('NO', 'PARSE' oder 'VALIDATE') | 20021016 | |||
| 2 | HANDLE | Call by reference | Object reference (TYPE REF TO) | CL_XADK_API | Handle | 20021016 | |||
| 3 | RESOURCE | Call by reference | Type reference (TYPE) | ADMI_URI | URI einer Ressource oder Kollektion | 20021016 | |||
| 4 | STATUS | Call by reference | Type reference (TYPE) | ADMI_STCHK | Status der XML-Prüfung | 20030616 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | XADK: DA Service Client Ausnahmen | 20021206 | ||
| 2 | XADK: DA Service Server Ausnahmen | 20021206 | ||
| 3 | XADK: Ausnahmen in den eigenen Methoden | 20021206 | ||
| 4 | XADK: Ausnahmen des WebServer oder Ablagesystems | 20021206 |
Method CHECK_PATH_EXTENSION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | PATH_EXTENSION | Call by reference | Type reference (TYPE) | ADMI_PEXT | Pfaderweiterung | 20041110 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | XADK: Ausnahmen in den eigenen Methoden | 20041110 |
Method CLOSE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | HANDLE | Call by reference | Object reference (TYPE REF TO) | CL_XADK_API | Handle | 20020902 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | XADK: Ausnahmen in den eigenen Methoden | 20021216 |
Method CLOSE_PARTITION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | HANDLE | Call by reference | Object reference (TYPE REF TO) | CL_XADK_API | Handle | 20020920 | |||
| 2 | PARTITION | Call by reference | Type reference (TYPE) | ADMI_PARTN | Partition | 20020920 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | XADK: Ausnahmen in den eigenen Methoden | 20021209 |
Method CONFIRM_DELETION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | HANDLE | Call by reference | Object reference (TYPE REF TO) | CL_XADK_API | Handle | 20020920 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | XADK: Ausnahmen in den eigenen Methoden | 20021209 |
Method DELETE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ARCHIVING_OBJECT | Call by reference | Type reference (TYPE) | ARCH_OBJ-OBJECT | Archivierungsobjekt | 20021203 | |||
| 2 | DELETE_RANGE | Call by reference | Type reference (TYPE) | ADMI_DRNG | Löschumfang | 20021203 | |||
| 3 | URI | Call by reference | Type reference (TYPE) | ADMI_URI | URI einer Ressource oder Kollektion | 20021203 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | XADK: DA Service Client Ausnahmen | 20021206 | ||
| 2 | XADK: DA Service Server Ausnahmen | 20021206 | ||
| 3 | XADK: Ausnahmen in den eigenen Methoden | 20021206 | ||
| 4 | XADK: Ausnahmen des WebServer oder Ablagesystems | 20021206 |
Method FREEZE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ARCHIVE_PATH | Call by reference | Type reference (TYPE) | ADMI_PATH | Archivpfad | 20021218 | |||
| 2 | ARCHIVING_OBJECT | Call by reference | Type reference (TYPE) | ARCH_OBJ-OBJECT | Archivierungsobjekt | 20021203 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | XADK: DA Service Client Ausnahmen | 20021206 | ||
| 2 | XADK: DA Service Server Ausnahmen | 20021206 | ||
| 3 | XADK: Ausnahmen in den eigenen Methoden | 20021206 | ||
| 4 | XADK: Ausnahmen des WebServer oder Ablagesystems | 20021206 |
Method GET Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CHECK_LEVEL | Call by reference | Type reference (TYPE) | ADMI_CHKL | 'NO' | 20031113 | |||
| 2 | HANDLE | Call by reference | Object reference (TYPE REF TO) | CL_XADK_API | Handle | 20020902 | |||
| 3 | MODE | Call by reference | Type reference (TYPE) | ADMI_GMODE | 'DELIVER' | 20031113 | |||
| 4 | RESOURCE | Call by reference | Type reference (TYPE) | ADMI_URI | URI einer Ressource | 20020923 | |||
| 5 | RESOURCE_DATA | Call by reference | Type reference (TYPE) | XSTRING | Daten der Ressource | 20020902 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | XADK: DA Service Client Ausnahmen | 20021206 | ||
| 2 | XADK: DA Service Server Ausnahmen | 20021206 | ||
| 3 | XADK: Ausnahmen in den eigenen Methoden | 20021206 | ||
| 4 | XADK: Ausnahmen des WebServer oder Ablagesystems | 20021206 |
Method GET_ACTIVE_SESSIONS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RT_SESSION_INFOS | Value transfer | Type reference (TYPE) | TT_SESSIONS | 20051220 |
Method GET_ACTIVE_SESSIONS on class CL_XADK_API has no exception.
Method GET_CUSTOMIZING Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ARCHIVING_OBJECT | Call by reference | Type reference (TYPE) | ARCH_OBJ-OBJECT | Archivierungsobjekt | 20020902 | |||
| 2 | HOME_PATH | Call by reference | Type reference (TYPE) | ADMI_HOME | Home-Pfad | 20020902 | |||
| 3 | PACKAGE_SIZE | Call by reference | Type reference (TYPE) | ARCH_PACSZ | Paketgröße | 20021202 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | XADK: Ausnahmen in den eigenen Methoden | 20021209 |
Method GIVE_STATISTICS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | HANDLE | Call by reference | Object reference (TYPE REF TO) | CL_XADK_API | XADK_API | 20030115 | |||
| 2 | TABLE | Call by reference | Type reference (TYPE) | ARCH_T_STA | Tabelle zur Übergabe der Statistikdaten an die Archivierung | 20030115 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | XADK: Ausnahmen in den eigenen Methoden | 20030120 |
Method HEAD Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RESULT | Call by reference | Type reference (TYPE) | ADMI_S_RES | Struktur für Ressourcen oder Kollektionen | 20021022 | |||
| 2 | URI | Call by reference | Type reference (TYPE) | ADMI_URI | URI einer Ressource oder Kollektion | 20021022 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | XADK: DA Service Client Ausnahmen | 20021206 | ||
| 2 | XADK: DA Service Server Ausnahmen | 20021206 | ||
| 3 | XADK: Ausnahmen in den eigenen Methoden | 20021206 | ||
| 4 | XADK: Ausnahmen des WebServer oder Ablagesystems | 20021206 |
Method INFO Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ARCHIVESTORE | Call by reference | Type reference (TYPE) | ADMI_ASTORE | Ablage | 20030207 | |||
| 2 | ARCHIVE_PATH | Call by reference | Type reference (TYPE) | ADMI_PATH | Archivpfad | 20021023 | |||
| 3 | DA_SERVICE_RELEASE | Call by reference | Type reference (TYPE) | STRING | Release des DA-Service | 20021217 | |||
| 4 | DBPRODUCTNAME | Call by reference | Type reference (TYPE) | STRING | Produktname des Datenbanksystems | 20021217 | |||
| 5 | DBPRODUCTVERSION | Call by reference | Type reference (TYPE) | STRING | Version des Datenbanksystems | 20021217 | |||
| 6 | JAVAVENDOR | Call by reference | Type reference (TYPE) | STRING | Hersteller der JAVA-Laufzeitumgebung | 20021217 | |||
| 7 | JAVAVERSION | Call by reference | Type reference (TYPE) | STRING | Version der JAVA-Laufzeitumgebung | 20021217 | |||
| 8 | JAVAVMNAME | Call by reference | Type reference (TYPE) | STRING | Name der Java-VM | 20021217 | |||
| 9 | JAVAVMVENDOR | Call by reference | Type reference (TYPE) | STRING | Hersteller der Java-VM | 20021217 | |||
| 10 | JAVAVMVERSION | Call by reference | Type reference (TYPE) | STRING | Version der Java-VM | 20021217 | |||
| 11 | JDBCDRIVERNAME | Call by reference | Type reference (TYPE) | STRING | Name des JDBC-Treibers | 20021217 | |||
| 12 | JDBCDRIVERVERSION | Call by reference | Type reference (TYPE) | STRING | Version des JDBC-Treibers | 20021217 | |||
| 13 | OSNAME | Call by reference | Type reference (TYPE) | STRING | Name des Betriebssystems | 20021217 | |||
| 14 | OSVERSION | Call by reference | Type reference (TYPE) | STRING | Version des Betriebssystems | 20021217 | |||
| 15 | PHYSICAL_PATH | Call by reference | Type reference (TYPE) | STRING | Physischer Pfad | 20021023 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | XADK: DA Service Client Ausnahmen | 20021206 | ||
| 2 | XADK: DA Service Server Ausnahmen | 20021206 | ||
| 3 | XADK: Ausnahmen in den eigenen Methoden | 20021206 | ||
| 4 | XADK: Ausnahmen des WebServer oder Ablagesystems | 20021206 |
Method LIST Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | AP_WITH_AR | Call by reference | Type reference (TYPE) | ADMI_AR_PATH | Expliziter Archivpfad (mit Archive Routing Anteil) | 20050502 | |||
| 2 | ARCHIVE_PATH | Call by reference | Type reference (TYPE) | ADMI_PATH | Archivpfad | 20020902 | |||
| 3 | DEL_ONLY | Call by reference | Type reference (TYPE) | ADMI_DELON | '' | Nur auf der Datenbank gelöschte Ressourcen ausgeben | 20041208 | ||
| 4 | HANDLE | Call by reference | Object reference (TYPE REF TO) | CL_XADK_API | Handle | 20020902 | |||
| 5 | RANGE | Call by reference | Type reference (TYPE) | ADMI_LRNG | 'ALL' | Ausgabeumfang | 20020917 | ||
| 6 | RECURSIVE | Call by reference | Type reference (TYPE) | ADMI_RECUR | '' | Auch unterhalb des Archivpfads suchen | 20020917 | ||
| 7 | RESULT_SET | Call by reference | Type reference (TYPE) | ADMI_T_RES | Tabelle der Ressourcen oder Kollektionen | 20020920 | |||
| 8 | TYPE_FILTER | Call by reference | Type reference (TYPE) | ADMI_RES_T | '' | Typfilter für Ressourcen | 20020917 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | XADK: DA Service Client Ausnahmen | 20021206 | ||
| 2 | XADK: DA Service Server Ausnahmen | 20021206 | ||
| 3 | XADK: Ausnahmen in den eigenen Methoden | 20021206 | ||
| 4 | XADK: Ausnahmen des WebServer oder Ablagesystems | 20021206 |
Method MAKE_COLLECTION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | AP_WITH_AR | Call by reference | Type reference (TYPE) | ADMI_AR_PATH | Expliziter Archivpfad (mit Archive Routing Anteil) | 20050502 | |||
| 2 | ARCHIVING_OBJECT | Call by reference | Type reference (TYPE) | ARCH_OBJ-OBJECT | Archivierungsobjekt | 20020902 | |||
| 3 | HANDLE | Call by reference | Object reference (TYPE REF TO) | CL_XADK_API | XADK_API | 20041122 | |||
| 4 | NEW_ARCHIVE_PATH | Call by reference | Type reference (TYPE) | ADMI_PATH | Neuer Archivpfad | 20020919 | |||
| 5 | NEW_COLLECTION_NAME | Call by reference | Type reference (TYPE) | ADMI_COLN | Name der neuen Kollektion | 20020902 | |||
| 6 | PATH_EXTENSION | Call by reference | Type reference (TYPE) | ADMI_PEXT | Pfaderweiterung | 20020911 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | XADK: DA Service Client Ausnahmen | 20021206 | ||
| 2 | XADK: DA Service Server Ausnahmen | 20021206 | ||
| 3 | XADK: Ausnahmen in den eigenen Methoden | 20021206 | ||
| 4 | XADK: Ausnahmen des WebServer oder Ablagesystems | 20021206 |
Method MODIFY_PATH Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | AP_WITH_AR | Call by reference | Type reference (TYPE) | ADMI_AR_PATH | Expliziter Archivpfad (mit Archive Routing Anteil) | 20050502 | |||
| 2 | ARCHIVING_OBJECT | Call by reference | Type reference (TYPE) | ARCH_OBJ-OBJECT | Archivierungsobjekt | 20040510 | |||
| 3 | CREATED_COLS | Call by reference | Type reference (TYPE) | I | Anzahl der angelegten Kollektionen | 20050610 | |||
| 4 | HANDLE | Call by reference | Object reference (TYPE REF TO) | CL_XADK_API | XADK_API | 20041123 | |||
| 5 | NEW_ARCHIVE_PATH | Call by reference | Type reference (TYPE) | ADMI_PATH | Neuer expliziter Archivpfad | 20040510 | |||
| 6 | PATH_EXTENSION | Call by reference | Type reference (TYPE) | ADMI_PEXT | Pfaderweiterung | 20040510 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | XADK: DA Service Client Ausnahmen | 20040510 | ||
| 2 | XADK: DA Service Server Ausnahmen | 20040510 | ||
| 3 | XADK: Ausnahmen in den eigenen Methoden | 20040510 | ||
| 4 | XADK: Ausnahmen des WebServer oder Ablagesystems | 20040510 |
Method OPEN_DELETE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ACTUALLY_DELETE | Call by reference | Type reference (TYPE) | ADMI_ACDEL | Löschen im Produktivmodus | 20020917 | |||
| 2 | ARCHIVE_PATH | Call by reference | Type reference (TYPE) | ADMI_PATH | Archivpfad | 20020903 | |||
| 3 | ARCHIVING_OBJECT | Call by reference | Type reference (TYPE) | ARCH_OBJ-OBJECT | Archivierungsobjekt | 20020903 | |||
| 4 | HANDLE | Call by reference | Object reference (TYPE REF TO) | CL_XADK_API | Handle | 20020903 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | XADK: Ausnahmen in den eigenen Methoden | 20021209 |
Method OPEN_PARTITION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | HANDLE | Call by reference | Object reference (TYPE REF TO) | CL_XADK_API | Handle | 20020920 | |||
| 2 | PARTITION | Call by reference | Type reference (TYPE) | ADMI_PARTN | Partition | 20020920 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | XADK: Ausnahmen in den eigenen Methoden | 20021209 |
Method OPEN_READ Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ARCHIVING_OBJECT | Call by reference | Type reference (TYPE) | ARCH_OBJ-OBJECT | Archivierungsobjekt | 20020902 | |||
| 2 | HANDLE | Call by reference | Object reference (TYPE REF TO) | CL_XADK_API | Handle | 20020902 | |||
| 3 | SELECTED_ARCHIVE_PATHS | Call by reference | Type reference (TYPE) | ADMI_T_PA | Tabelle der ausgewählten Archivpfade | 20020919 | |||
| 4 | USE_PRESELECTION | Call by reference | Type reference (TYPE) | ADMI_USPRE | '' | Vorausgewählte Kollektionen verwenden | 20020902 | ||
| 5 | USE_SELECTION_POPUP | Call by reference | Type reference (TYPE) | ADMI_USSPO | '' | Popup zur Auswahl der Kollektionen anzeigen | 20020919 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | XADK: Ausnahmen in den eigenen Methoden | 20021209 |
Method OPEN_WRITE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ARCHIVING_OBJECT | Call by reference | Type reference (TYPE) | ARCH_OBJ-OBJECT | Archivierungsobjekt | 20020902 | |||
| 2 | AUTO_START_DEL_IN_TEST_MODE | Call by reference | Type reference (TYPE) | ADMI_DELST | 'X' | Automatischer Start des Löschprogramms | 20020902 | ||
| 3 | BYPASS_ADMINISTRATION | Call by reference | Type reference (TYPE) | ADMI_NOADM | Archivierungslauf nicht in der Adminstration berücksichtigen | 20030319 | |||
| 4 | COMMENT | Call by reference | Type reference (TYPE) | ADMI_TEXT | Vermerk zum Archivierungslauf | 20020919 | |||
| 5 | CURRENT_ARCHIVE_PATH | Call by reference | Type reference (TYPE) | ADMI_PATH | Aktueller Archivpfad | 20020902 | |||
| 6 | EXISTING_COLLECTION_NAME | Call by reference | Type reference (TYPE) | ADMI_COLN | Name einer existierenden Kollektion zum Fortschreiben | 20030319 | |||
| 7 | HANDLE | Call by reference | Object reference (TYPE REF TO) | CL_XADK_API | Handle | 20020902 | |||
| 8 | NEW_COLLECTION_NAME | Call by reference | Type reference (TYPE) | ADMI_COLN | Vorgegebener Name für neue Kollektion | 20020902 | |||
| 9 | PATH_EXTENSION | Call by reference | Type reference (TYPE) | ADMI_PEXT | Pfaderweiterung | 20020910 | |||
| 10 | STORE_RESOURCES | Call by reference | Type reference (TYPE) | ADMI_RESST | 'X' | Ressourcen schreiben | 20020902 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | XADK: DA Service Client Ausnahmen | 20021206 | ||
| 2 | XADK: DA Service Server Ausnahmen | 20021206 | ||
| 3 | XADK: Ausnahmen in den eigenen Methoden | 20021206 | ||
| 4 | XADK: Ausnahmen des WebServer oder Ablagesystems | 20021206 |
Method PACK Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ARCHIVE_PATH | Call by reference | Type reference (TYPE) | ADMI_PATH | Archivpfad | 20021212 | |||
| 2 | ARCHIVING_OBJECT | Call by reference | Type reference (TYPE) | ARCH_OBJ-OBJECT | Archivierungsobjekt | 20021212 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | XADK: DA Service Client Ausnahmen | 20021212 | ||
| 2 | XADK: DA Service Server Ausnahmen | 20021212 | ||
| 3 | XADK: Ausnahmen in den eigenen Methoden | 20021212 | ||
| 4 | XADK: Ausnahmen des WebServer oder Ablagesystems | 20021212 |
Method PACK_STATUS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ARCHIVE_PATH | Call by reference | Type reference (TYPE) | ADMI_PATH | Archivpfad | 20030522 | |||
| 2 | ARCHIVING_OBJECT | Call by reference | Type reference (TYPE) | ARCH_OBJ-OBJECT | Archivierungsobjekt | 20030522 | |||
| 3 | PACK_STATUS | Call by reference | Type reference (TYPE) | STRING | Status des PACK Prozesses | 20030522 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | XADK: DA Service Client Ausnahmen | 20030522 | ||
| 2 | XADK: DA Service Server Ausnahmen | 20030522 | ||
| 3 | XADK: Ausnahmen in den eigenen Methoden | 20030522 | ||
| 4 | XADK: Ausnahmen des WebServer oder Ablagesystems | 20030522 |
Method PICK_PARTITION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | HANDLE | Call by reference | Object reference (TYPE REF TO) | CL_XADK_API | Handle | 20020920 | |||
| 2 | PARTITION | Call by reference | Type reference (TYPE) | ADMI_PARTN | Partitions-ID | 20030212 | |||
| 3 | RESOURCES | Call by reference | Type reference (TYPE) | ADMI_T_URI | Tabelle der URIs | 20021218 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | XADK: Ausnahmen in den eigenen Methoden | 20021209 |
Method PICK_RESOURCES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | HANDLE | Call by reference | Object reference (TYPE REF TO) | CL_XADK_API | Handle | 20020919 | |||
| 2 | RESOURCES | Call by reference | Type reference (TYPE) | ADMI_T_URI | Tabelle der URIs | 20021218 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | XADK: Ausnahmen in den eigenen Methoden | 20021209 |
Method PROPERTY_INDEX_CREATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ARCHIVING_OBJECT | Call by reference | Type reference (TYPE) | ARCH_OBJ-OBJECT | Archivierungsobjekt | 20021202 | |||
| 2 | INDEX_NAME | Call by reference | Type reference (TYPE) | ADMI_INDN | Name des Eigenschaftsindex | 20021202 | |||
| 3 | PROPERTY_DEFINITIONS | Call by reference | Type reference (TYPE) | ADMI_T_IND | Definition der Eigenschaften | 20021216 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | XADK: DA Service Client Ausnahmen | 20021206 | ||
| 2 | XADK: DA Service Server Ausnahmen | 20021206 | ||
| 3 | XADK: Ausnahmen in den eigenen Methoden | 20021206 | ||
| 4 | XADK: Ausnahmen des WebServer oder Ablagesystems | 20021206 |
Method PROPERTY_INDEX_DESCRIBE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ARCHIVING_OBJECT | Call by reference | Type reference (TYPE) | ARCH_OBJ-OBJECT | Archivierungsobjekt | 20030207 | |||
| 2 | INDEX_NAME | Call by reference | Type reference (TYPE) | ADMI_INDN | Name eines Eigenschaftsindex | 20030207 | |||
| 3 | PROPERTY_DEFINITIONS | Call by reference | Type reference (TYPE) | ADMI_T_IND | Definitionen der Eigenschaften eines Eingenschaftsindex | 20030207 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | XADK: DA Service Client Ausnahmen | 20030207 | ||
| 2 | XADK: DA Service Server Ausnahmen | 20030207 | ||
| 3 | XADK: Ausnahmen in den eigenen Methoden | 20030207 | ||
| 4 | XADK: Ausnahmen des WebServer oder Ablagesystems | 20030207 |
Method PROPERTY_INDEX_DROP Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ARCHIVING_OBJECT | Call by reference | Type reference (TYPE) | ARCH_OBJ-OBJECT | Archivierungsobjekt | 20021203 | |||
| 2 | INDEX_NAME | Call by reference | Type reference (TYPE) | ADMI_INDN | Name des Eigenschaftsindex | 20021203 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | XADK: DA Service Client Ausnahmen | 20021206 | ||
| 2 | XADK: DA Service Server Ausnahmen | 20021206 | ||
| 3 | XADK: Ausnahmen in den eigenen Methoden | 20021206 | ||
| 4 | XADK: Ausnahmen des WebServer oder Ablagesystems | 20021206 |
Method PROPERTY_INDEX_GET Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ARCHIVING_OBJECT | Call by reference | Type reference (TYPE) | ARCH_OBJ-OBJECT | Archivierungsobjekt | 20021212 | |||
| 2 | INDEX_NAME | Call by reference | Type reference (TYPE) | ADMI_INDN | Name des Eigenschaftsindex | 20021212 | |||
| 3 | PROPERTIES | Call by reference | Type reference (TYPE) | ADMI_T_PRO | Tabelle der Eigenschaften | 20021212 | |||
| 4 | URI | Call by reference | Type reference (TYPE) | ADMI_URI | URI einer Ressource | 20021212 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | XADK: DA Service Client Ausnahmen | 20021212 | ||
| 2 | XADK: DA Service Server Ausnahmen | 20021212 | ||
| 3 | XADK: Ausnahmen in den eigenen Methoden | 20021212 | ||
| 4 | XADK: Ausnahmen des WebServer oder Ablagesystems | 20021212 |
Method PROPERTY_INDEX_INSERT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ARCHIVE_PATH | Call by reference | Type reference (TYPE) | ADMI_PATH | Archivpfad | 20021202 | |||
| 2 | ARCHIVING_OBJECT | Call by reference | Type reference (TYPE) | ARCH_OBJ-OBJECT | Archivierungsobjekt | 20021202 | |||
| 3 | PROPERTIES | Call by reference | Type reference (TYPE) | ADMI_T_PRO | Eigenschaften | 20021202 | |||
| 4 | RESOURCE_NAME | Call by reference | Type reference (TYPE) | ADMI_RES | Name einer Ressource | 20021202 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | XADK: DA Service Client Ausnahmen | 20021206 | ||
| 2 | XADK: DA Service Server Ausnahmen | 20021206 | ||
| 3 | XADK: Ausnahmen in den eigenen Methoden | 20021206 | ||
| 4 | XADK: Ausnahmen des WebServer oder Ablagesystems | 20021206 |
Method PROPERTY_INDEX_LIST Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ARCHIVING_OBJECT | Call by reference | Type reference (TYPE) | ARCH_OBJ-OBJECT | 20030925 | ||||
| 2 | INDEX_NAMES | Call by reference | Type reference (TYPE) | ADMI_T_IN | 20030925 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | XADK: Ausnahmen in den eigenen Methoden | 20030925 |
Method PUT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ARCHIVE_PATH | Call by reference | Type reference (TYPE) | ADMI_PATH | Archivpfad | 20020919 | |||
| 2 | CHECK_LEVEL | Call by reference | Type reference (TYPE) | ADMI_CHKL | 'NO' | Prüfung ('NO', 'PARSE' oder 'VALIDATE') | 20020902 | ||
| 3 | CREATE_UTC | Call by reference | Type reference (TYPE) | ADMI_TSTP | UTC Zeitstempel (kurz) | 20020919 | |||
| 4 | HANDLE | Call by reference | Object reference (TYPE REF TO) | CL_XADK_API | Handle | 20020902 | |||
| 5 | NAMESPACE | Call by reference | Type reference (TYPE) | ADMI_NAMSP | Namespace für Schema (XSD) | 20021011 | |||
| 6 | PARTITION | Call by reference | Type reference (TYPE) | ADMI_PARTN | Name einer Partition | 20020919 | |||
| 7 | PROPERTIES | Call by reference | Type reference (TYPE) | ADMI_T_PRO | Tabelle der Eigenschaften | 20020919 | |||
| 8 | RESOURCE_DATA | Call by reference | Type reference (TYPE) | XSTRING | Ressource | 20020902 | |||
| 9 | RESOURCE_NAME | Call by reference | Type reference (TYPE) | ADMI_RES | Name der Ressource | 20020902 | |||
| 10 | RESOURCE_TYPE | Call by reference | Type reference (TYPE) | ADMI_RES_T | Typ der Ressource | 20020902 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | XADK: DA Service Client Ausnahmen | 20021206 | ||
| 2 | XADK: DA Service Server Ausnahmen | 20021206 | ||
| 3 | XADK: Ausnahmen in den eigenen Methoden | 20021206 | ||
| 4 | XADK: Ausnahmen des WebServer oder Ablagesystems | 20021206 |
Method ROLLBACK_PARTITIONS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | HANDLE | Call by reference | Object reference (TYPE REF TO) | CL_XADK_API | XADK_API | 20030313 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | XADK: DA Service Client Ausnahmen | 20030313 | ||
| 2 | XADK: DA Service Server Ausnahmen | 20030313 | ||
| 3 | XADK: Ausnahmen in den eigenen Methoden | 20030313 | ||
| 4 | XADK: Ausnahmen des WebServer oder Ablagesystems | 20030313 |
Method SELECT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | AP_WITH_AR | Call by reference | Type reference (TYPE) | ADMI_AR_PATH | Expliziter Archivpfad (mit Archive Routing Anteil) | 20050503 | |||
| 2 | ARCHIVE_PATH | Call by reference | Type reference (TYPE) | ADMI_PATH | Archivpfad | 20021010 | |||
| 3 | DEL_ONLY | Call by reference | Type reference (TYPE) | ADMI_DELON | Nur in der Datenbank gelöschte Ressourcen ausgeben | 20041209 | |||
| 4 | HANDLE | Call by reference | Object reference (TYPE REF TO) | CL_XADK_API | Handle | 20021010 | |||
| 5 | INDEX_NAME | Call by reference | Type reference (TYPE) | ADMI_INDN | Eigenschaftsindex | 20021010 | |||
| 6 | MAXHITS | Call by reference | Type reference (TYPE) | ADMI_MAXHI | Einschränkung der Ergebnismenge | 20030911 | |||
| 7 | RECURSIVE | Call by reference | Type reference (TYPE) | ADMI_RECUR | Auch unterhalb des Archivpfads suchen | 20021010 | |||
| 8 | RESULT_SET | Call by reference | Type reference (TYPE) | ADMI_T_RES | Tabelle der Ressourcen | 20021010 | |||
| 9 | WHERE_CLAUSE | Call by reference | Type reference (TYPE) | ADMI_WCLAU | Suchbedingung (als SQL92 WHERE-Klausel) | 20021010 | |||
| 10 | WHERE_RANGES | Call by reference | Type reference (TYPE) | RSDS_FRANGE_T | Freie Abgrenzungen im Format RSDS_TRANGE (Type-Pool RSDS) | 20030131 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | XADK: DA Service Client Ausnahmen | 20021206 | ||
| 2 | XADK: DA Service Server Ausnahmen | 20021206 | ||
| 3 | XADK: Ausnahmen in den eigenen Methoden | 20021206 | ||
| 4 | XADK: Ausnahmen des WebServer oder Ablagesystems | 20021206 |
Method UNPACK Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ARCHIVE_PATH | Call by reference | Type reference (TYPE) | ADMI_PATH | Archivpfad | 20030522 | |||
| 2 | ARCHIVING_OBJECT | Call by reference | Type reference (TYPE) | ARCH_OBJ-OBJECT | Archivierungsobjekt | 20030522 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | XADK: DA Service Client Ausnahmen | 20030522 | ||
| 2 | XADK: DA Service Server Ausnahmen | 20030522 | ||
| 3 | XADK: Ausnahmen in den eigenen Methoden | 20030522 | ||
| 4 | XADK: Ausnahmen des WebServer oder Ablagesystems | 20030522 |
Method VERIFY_INTEGRITY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ARCHIVE_PATH | Call by reference | Type reference (TYPE) | ADMI_PATH | Archivpfad | 20050118 | |||
| 2 | ARCHIVING_OBJECT | Call by reference | Type reference (TYPE) | ARCH_OBJ-OBJECT | Archivierungsobjekt | 20050118 | |||
| 3 | RECURSIVE | Call by reference | Type reference (TYPE) | ADMI_RECUR | '' | Rekursiv: Auch unterhalb des Archivpfads suchen | 20050118 | ||
| 4 | STOP_AT_ERROR | Call by reference | Type reference (TYPE) | ADMI_STOPE | 'X' | Abbruch bei falscher Prüfsumme einer Ressource | 20050118 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | XADK: DA Service Client Ausnahmen | 20050118 | ||
| 2 | XADK: DA Service Server Ausnahmen | 20050118 | ||
| 3 | XADK: Ausnahmen in den eigenen Methoden | 20050118 | ||
| 4 | XADK: Ausnahmen des WebServer oder Ablagesystems | 20050118 |
Method WRITE_STATISTICS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | HANDLE | Call by reference | Object reference (TYPE REF TO) | CL_XADK_API | 20030428 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | XADK: Ausnahmen in den eigenen Methoden | 20030428 |
Method _SYNC_HOME_PATH Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ACTION | Call by reference | Type reference (TYPE) | ADMI_ACTN | Aktion zur Synchronisation eines Home-Pfades | 20021218 | |||
| 2 | ARCHIVE_STORE | Call by reference | Type reference (TYPE) | ADMI_ASTOR | Ablage (Archive Store XML-Archivierung) | 20021218 | |||
| 3 | ARCHIVING_OBJECT | Call by reference | Type reference (TYPE) | ARCH_OBJ-OBJECT | Archivierungsobjekt | 20021219 | |||
| 4 | CLIENT | Call by reference | Type reference (TYPE) | MANDT | SY-MANDT | 20030430 | |||
| 5 | HOME_PATH | Call by reference | Type reference (TYPE) | ADMI_PATH | Home-Pfad | 20021218 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | XADK: DA Service Client Ausnahmen | 20021218 | ||
| 2 | XADK: DA Service Server Ausnahmen | 20021218 | ||
| 3 | XADK: Ausnahmen in den eigenen Methoden | 20021218 | ||
| 4 | XADK: Ausnahmen des WebServer oder Ablagesystems | 20021218 |
Event Signatures
Event INTERRUPTION_REQUESTED Signature
| # | Parameter | Type | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | HANDLE | Exporting | Value transfer | Object reference (TYPE REF TO) | CL_XADK_API | 20030722 |
History
| Last changed by/on | SAP | 20110908 |
| SAP Release Created in | 640 |