SAP CL_XADK_API OO Class - XADK_API
CL_XADK_API is a standard SAP object class available within R/3 SAP systems depending on your version and release level. You can view/maintain the class details by entering its name into the relevant SAP transactions such as SE24, SE80 or even SE84. Below is the documentation available for class CL_XADK_API including details of:
- Interface class implementations
- Inheritance details
- Methods defined within class ( including link to full details )
- Attributes ( including initial values )
- Class Events
Method list of CL_XADK_API SAP class
A method is a coding block that performs a certain procedure (i.e. ABAP functionality) on an object within the overall SAP class. In simple terms if the object is an SAP database table a method could be the procedure to add a record or to delete a record. If you are new to OO in many respects, the implementation of a method is similar to a function module and can be called in a very similar way using CALL METHOD.
Instead of "CALL FUNCTION", Methods are referenced using the following syntax: CALL METHOD =>methodname EXPORTING/IMPORTING...
| Method Name | Description | Visability |
| CHECK | Check Resources for XML Well-Formedness | Public |
| CALL METHOD cl_xadk_api=>CHECK...more details | ||
| CHECK_PATH_EXTENSION | Syntax Check of the Path Extension Parameter | Public |
| CALL METHOD cl_xadk_api=>CHECK_PATH_EXTENSION...more details | ||
| CLOSE | Close Handle (and Archiving Session) | Public |
| CALL METHOD cl_xadk_api=>CLOSE...more details | ||
| CLOSE_PARTITION | Close Partition | Public |
| CALL METHOD cl_xadk_api=>CLOSE_PARTITION...more details | ||
| CONFIRM_DELETION | Confirm Deletion of Resources | Public |
| CALL METHOD cl_xadk_api=>CONFIRM_DELETION...more details | ||
| DELETE | Delete Resources or Collections | Public |
| CALL METHOD cl_xadk_api=>DELETE...more details | ||
|
| ||
| FREEZE | Freeze Collection | Public |
| CALL METHOD cl_xadk_api=>FREEZE...more details | ||
| GET | Read Resources from Archive | Public |
| CALL METHOD cl_xadk_api=>GET...more details | ||
| GET_ACTIVE_SESSIONS | Private | |
| CALL METHOD cl_xadk_api=>GET_ACTIVE_SESSIONS...more details | ||
| GET_CUSTOMIZING | Read Customizing Information of an Archiving Object | Public |
| CALL METHOD cl_xadk_api=>GET_CUSTOMIZING...more details | ||
| GIVE_STATISTICS | Transfer of Statistics Data | Public |
| CALL METHOD cl_xadk_api=>GIVE_STATISTICS...more details | ||
| HEAD | Existence Check for Resources or Collections | Public |
| CALL METHOD cl_xadk_api=>HEAD...more details | ||
| INFO | Information about the XML DAS and an Archive Path | Public |
| CALL METHOD cl_xadk_api=>INFO...more details | ||
| LIST | Display Resources List | Public |
| CALL METHOD cl_xadk_api=>LIST...more details | ||
| MAKE_COLLECTION | Create Collection | Public |
| CALL METHOD cl_xadk_api=>MAKE_COLLECTION...more details | ||
| MODIFY_PATH | Creation of One or More Collections | Public |
| CALL METHOD cl_xadk_api=>MODIFY_PATH...more details | ||
| OPEN_DELETE | Open Delete Handle | Public |
| CALL METHOD cl_xadk_api=>OPEN_DELETE...more details | ||
| OPEN_PARTITION | Open Partition | Public |
| CALL METHOD cl_xadk_api=>OPEN_PARTITION...more details | ||
| OPEN_READ | Open Read Handle | Public |
| CALL METHOD cl_xadk_api=>OPEN_READ...more details | ||
| OPEN_WRITE | Open Write Handle and Generate Archiving Session | Public |
| CALL METHOD cl_xadk_api=>OPEN_WRITE...more details | ||
| PACK | Pack Resources of a Collection | Public |
| CALL METHOD cl_xadk_api=>PACK...more details | ||
| PACK_STATUS | Determine the Status of the Asynchronous PACK Process | Public |
| CALL METHOD cl_xadk_api=>PACK_STATUS...more details | ||
| PICK_PARTITION | Make Resources of a Partition Available for Deletion | Public |
| CALL METHOD cl_xadk_api=>PICK_PARTITION...more details | ||
| PICK_RESOURCES | Make Resources Available for Deletion | Public |
| CALL METHOD cl_xadk_api=>PICK_RESOURCES...more details | ||
| PROPERTY_INDEX_CREATE | Create Property Index | Public |
| CALL METHOD cl_xadk_api=>PROPERTY_INDEX_CREATE...more details | ||
| PROPERTY_INDEX_DESCRIBE | Read Properties of a Property Index | Public |
| CALL METHOD cl_xadk_api=>PROPERTY_INDEX_DESCRIBE...more details | ||
| PROPERTY_INDEX_DROP | Delete Property Index | Public |
| CALL METHOD cl_xadk_api=>PROPERTY_INDEX_DROP...more details | ||
| PROPERTY_INDEX_GET | Read Resource Properties From an Index | Public |
| CALL METHOD cl_xadk_api=>PROPERTY_INDEX_GET...more details | ||
| PROPERTY_INDEX_INSERT | Insert Resource Properties Into an Index | Public |
| CALL METHOD cl_xadk_api=>PROPERTY_INDEX_INSERT...more details | ||
| PROPERTY_INDEX_LIST | List Property Indexes for an Archiving Object | Public |
| CALL METHOD cl_xadk_api=>PROPERTY_INDEX_LIST...more details | ||
| PUT | Write Resource Into Archive | Public |
| CALL METHOD cl_xadk_api=>PUT...more details | ||
| ROLLBACK_PARTITIONS | Deletion of Resource During Write in Case of Termination | Public |
| CALL METHOD cl_xadk_api=>ROLLBACK_PARTITIONS...more details | ||
| SELECT | Select Resources | Public |
| CALL METHOD cl_xadk_api=>SELECT...more details | ||
| UNPACK | Unpack the Resources of a Collection | Public |
| CALL METHOD cl_xadk_api=>UNPACK...more details | ||
| VERIFY_INTEGRITY | Check Sum Verification by Collection | Public |
| CALL METHOD cl_xadk_api=>VERIFY_INTEGRITY...more details | ||
| WRITE_STATISTICS | Output of Statistics | Public |
| CALL METHOD cl_xadk_api=>WRITE_STATISTICS...more details | ||
| _SYNC_HOME_PATH | Administration: Synchronize HOME Path | Public |
| CALL METHOD cl_xadk_api=>_SYNC_HOME_PATH...more details | ||
CL_XADK_API attributes
List of attributes within class CL_ABAP_CHAR_UTILITIES. These can be referenced using the following syntax CL_ABAP_CHAR_UTILITIES=>. Although depending on where you are inserting the ABAP code you do need to check if the attribute is public or private.
| Name | Level | Description | Initial Value | Type | Visability |
| BOOLEAN_FALSE | Instance Attribute | LIKE | Private | ||
| BOOLEAN_TRUE | Instance Attribute | LIKE | Private | ||
| DO_NOT_DELETE_ADMIN | Static Attribute | Single-Character Flag | BOOLEAN_FALSE | LIKE CHAR1 | Private |
| ROLLBACK_ACTIVE | Static Attribute | Single-Character Indicator | BOOLEAN_FALSE | LIKE CHAR1 | Public |
Events of Class CL_XADK_API
Events are created within your class using special event handler methods. These must be registered at runtime for the event and can then be triggered using the ABAP syntax: RAISE EVENT EXPOTING... INTERRUPTION_REQUESTED - Interruption Request Was TriggeredCL_XADK_API types
BOOLEAN -TS_SESSION -
TT_SESSIONS -
Links to Related Class(s)
CL_XADK_...Full list of available SAP object classes
Search for further information about these or an SAP related objects