SAP ABAP Class CL_XML_OPERATIONS (Generic XML operations)
Hierarchy
BBPCRM (Software Component) BBPCRM
   CA-GTF-CSC (Application Component) Country-Specific Objects
     ID-FI (Package) International development: FI-GL/AP/AR
Properties
Class CL_XML_OPERATIONS  
Short Description Generic XML operations    
Super Class    
Instantiability of a Class 2  Public 
Final    
General Data
Message Class    
Program status     
Category 0   
Package ID-FI   International development: FI-GL/AP/AR 
Created 20100602   SAP 
Last change 20130531   SAP 
Shared Memory-enabled    
Fixed point arithmetic    
Unicode checks active    
Forward declarations
Class CL_XML_OPERATIONS has no forward declaration.
Interfaces
Class CL_XML_OPERATIONS has no interface implemented.
Friends
Class CL_XML_OPERATIONS has no friend class.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 BYTE_ORDER Static Attribute Public Type reference (TYPE) I Byte order defined in the schema document 20100602
2 C_ATTR_BASE Constant Public Type reference (TYPE) CHAR50 'BASE' Base attirbute 20100602
3 C_ATTR_CONTENT Constant Public Type reference (TYPE) CHAR50 'CONTENT' Content attribute 20100602
4 C_ATTR_DEF Constant Public Type reference (TYPE) CHAR50 'DEFAULT' Default attribute 20100602
5 C_ATTR_FIX Constant Public Type reference (TYPE) CHAR50 'FIXED' Fixed attribute 20100602
6 C_ATTR_MAXO Constant Public Type reference (TYPE) CHAR50 'MAXOCCURS' Maxoccurs attribute 20100602
7 C_ATTR_MINO Constant Public Type reference (TYPE) CHAR50 'MINOCCURS' Minoccurs attribute 20100602
8 C_ATTR_NAME Constant Public Type reference (TYPE) CHAR50 'NAME' Name attribute 20100602
9 C_ATTR_ORDER Constant Public Type reference (TYPE) CHAR50 'ORDER' Order attribute 20100602
10 C_ATTR_REF Constant Public Type reference (TYPE) CHAR50 'REF' Reference attribute 20100602
11 C_ATTR_SCHEMALOC Constant Public Type reference (TYPE) CHAR50 'SCHEMALOCATION' Schemalocation attribute 20100602
12 C_ATTR_TYPE Constant Public Type reference (TYPE) CHAR50 'TYPE' Type attribute 20100602
13 C_ATTR_USE Constant Public Type reference (TYPE) CHAR50 'USE' Use attribute 20100602
14 C_ELEM_ALL Constant Public Type reference (TYPE) CHAR50 'ALL' All element 20100602
15 C_ELEM_ANNO Constant Public Type reference (TYPE) CHAR50 'ANNOTATION' Annotation element 20100602
16 C_ELEM_APPINFO Constant Public Type reference (TYPE) CHAR50 'APPINFO' Appinfo element 20100602
17 C_ELEM_ATTGROUP Constant Public Type reference (TYPE) CHAR50 'ATTRIBUTEGROUP' Attributegroup element 20100602
18 C_ELEM_ATTRIBUTE Constant Public Type reference (TYPE) CHAR50 'ATTRIBUTE' Attribute element 20100602
19 C_ELEM_CCONTENT Constant Public Type reference (TYPE) CHAR50 'COMPLEXCONTENT' Complex content element 20100602
20 C_ELEM_CHOICE Constant Public Type reference (TYPE) CHAR50 'CHOICE' Choice element 20100602
21 C_ELEM_CTYPE Constant Public Type reference (TYPE) CHAR50 'COMPLEXTYPE' Complex Type element 20100602
22 C_ELEM_DOCU Constant Public Type reference (TYPE) CHAR50 'DOCUMENTATION' Documentation element 20100602
23 C_ELEM_ELEMENT Constant Public Type reference (TYPE) CHAR50 'ELEMENT' Element element 20100602
24 C_ELEM_EXT Constant Public Type reference (TYPE) CHAR50 'EXTENSION' Extension element 20100602
25 C_ELEM_GROUP Constant Public Type reference (TYPE) CHAR50 'GROUP' Group element 20100602
26 C_ELEM_RES Constant Public Type reference (TYPE) CHAR50 'RESTRICTION' Restriction element 20100602
27 C_ELEM_SEQUENCE Constant Public Type reference (TYPE) CHAR50 'SEQUENCE' Sequence element 20100602
28 C_ELEM_STYPE Constant Public Type reference (TYPE) CHAR50 'SIMPLETYPE' Simple Type element 20100602
29 C_ENT_AMP Constant Public Type reference (TYPE) CHAR05 '&' Entity & 20100602
30 C_ENT_APOS Constant Public Type reference (TYPE) CHAR05 '''' Entity ' 20100602
31 C_ENT_GT Constant Public Type reference (TYPE) CHAR05 '>' Entity > 20100602
32 C_ENT_LT Constant Public Type reference (TYPE) CHAR05 '<' Entity < 20100602
33 C_ENT_QUOT Constant Public Type reference (TYPE) CHAR05 '"' Entity " 20100602
34 C_SCHEMA Constant Public Type reference (TYPE) CHAR50 'SCHEMA' Schema element 20100602
35 ENCODING Static Attribute Public Type reference (TYPE) STRING Encoding defined in the schema document 20100602
36 FALSE Constant Public Type reference (TYPE) BOOLEAN SPACE Flase 20100602
37 GROUP_MINO Instance attribute Public Type reference (TYPE) STRING Minoccurs for a group 20100602
38 IS_GROUP Instance attribute Public Type reference (TYPE) BOOLEAN Flag to indicate a group element 20100602
39 MAIN_XML Static Attribute Protected Object reference (TYPE REF TO) IF_IXML Main XML factory 20100602
40 PARENT_NAME Instance attribute Public Type reference (TYPE) STRING Parent name of a node 20100602
41 TRUE Constant Public Type reference (TYPE) BOOLEAN 'X' True 20100602
Methods
# Method Level Visibility Method type Description Created on
1 APPEND_MESSAGE_TAB Instance method Public Method Append message table 20100602
2 APPEND_NODES Instance method Protected Method Append nodes to the XML document 20100602
3 CHECK_CREATE_DIR Instance method Protected Method Check and create directory 20100602
4 CHECK_FILE_EXISTS Instance method Protected Method Check if the download file already exists 20100602
5 CONSTRUCTOR Instance method Public Constructor Constructor 20100602
6 CONVERT_TO_XML Instance method Public Method Create XML data from table 20100602
7 CREATE_ROOT Instance method Protected Method Create XML root element 20100602
8 CREATE_SCHEMA_DOCUMENT Instance method Public Method Create logical document for the dowloaded schema 20100602
9 DELETE_OPTIONAL_CTYPE Instance method Private Method Delete optional complextype nodes in XML document 20100602
10 DELETE_OPTIONAL_NODE Instance method Protected Method Delete optional nodes in the XML document 20100602
11 EXPORT_TO_FILE Instance method Public Method Export XML file (download) 20100602
12 GET_ENCODING Instance method Protected Method Get encoding and byte order of the schema 20100602
13 GET_NODES_FROM_DATA Instance method Public Method Get nodes from schema document 20100602
14 IMPORT_FROM_FILE Instance method Public Method Import XML schema file (upload) 20100602
15 RENDER_XML_DOCUMENT Instance method Public Method Render the XML document 20100602
16 SET_ENCODING Instance method Public Method Set encoding for the document 20100602
17 VALIDATE_XML_FILE Instance method Public Method Validate XML file agianst the XML schema 20100602
Events
Class CL_XML_OPERATIONS has no event.
Types
Class CL_XML_OPERATIONS has no local type.
Method Signatures

Method APPEND_MESSAGE_TAB Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing MSGID Value transfer Type reference (TYPE) SYMSGID Message class 20100602
2 Importing MSGNO Value transfer Type reference (TYPE) SYMSGNO Message number 20100602
3 Importing MSGTY Value transfer Type reference (TYPE) SYMSGTY Message type 20100602
4 Importing MSGV1 Value transfer Type reference (TYPE) ANY Message variable 1 20100602
5 Importing MSGV2 Value transfer Type reference (TYPE) ANY Message variable 2 20100602
6 Importing MSGV3 Value transfer Type reference (TYPE) ANY Message variable 3 20100602
7 Importing MSGV4 Value transfer Type reference (TYPE) ANY Message variable 4 20100602
8 Changing MSG_TAB Call by reference Type reference (TYPE) STANDARD TABLE Message table 20100602

Method APPEND_MESSAGE_TAB on class CL_XML_OPERATIONS has no exception.

Method APPEND_NODES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing ATTR_LIST Call by reference Type reference (TYPE) ATTR_XML_T List of attributes 20100602
2 Importing DOCUMENT Value transfer Object reference (TYPE REF TO) IF_IXML_DOCUMENT Document reference 20100602
3 Importing ELEMENT Value transfer Object reference (TYPE REF TO) IF_IXML_ELEMENT Element reference 20100602
4 Changing INDEX Value transfer Type reference (TYPE) SY-TABIX Table index 20100602
5 Importing NODE_LIST Call by reference Type reference (TYPE) NODE_XML_T List of nodes 20100602

Method APPEND_NODES on class CL_XML_OPERATIONS has no exception.

Method CHECK_CREATE_DIR Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing FPATH Call by reference Type reference (TYPE) STRING File path 20100602
2 Changing IS_OK Call by reference Type reference (TYPE) BOOLEAN Return code 20100602
3 Changing MSGLOG Call by reference Type reference (TYPE) STANDARD TABLE Message log 20100602

Method CHECK_CREATE_DIR on class CL_XML_OPERATIONS has no exception.

Method CHECK_FILE_EXISTS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing FILENAME Call by reference Type reference (TYPE) STRING Existing file name 20100602
2 Changing FILEPATH Call by reference Type reference (TYPE) STRING Existing file path 20100602
3 Exporting IS_OK Call by reference Type reference (TYPE) BOOLEAN Return code 20100602
4 Changing MSGLOG Call by reference Type reference (TYPE) STANDARD TABLE Message log 20100602
5 Changing RET_FILENAME Call by reference Type reference (TYPE) STRING New file name with path 20100602

Method CHECK_FILE_EXISTS on class CL_XML_OPERATIONS has no exception.

Method CONSTRUCTOR Signature

Method CONSTRUCTOR on class CL_XML_OPERATIONS has no parameter.
Method CONSTRUCTOR on class CL_XML_OPERATIONS has no exception.

Method CONVERT_TO_XML Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing ATTR_LIST Call by reference Type reference (TYPE) ATTR_XML_T Table containing attributes for a node with value 20100602
2 Importing DEL_OPTIO Call by reference Type reference (TYPE) BOOLEAN Delete optional node(s) 20100602
3 Changing DOCUMENT Call by reference Object reference (TYPE REF TO) IF_IXML_DOCUMENT Document reference 20100602
4 Importing FILENAME Call by reference Type reference (TYPE) STRING Download file name 20100602
5 Exporting IS_OK Call by reference Type reference (TYPE) BOOLEAN Return code 20100602
6 Changing MSGLOG Call by reference Type reference (TYPE) STANDARD TABLE Message log 20100602
7 Changing NODE_LIST Call by reference Type reference (TYPE) NODE_XML_T Table containing node name with data 20100602
8 Importing ROOT Call by reference Type reference (TYPE) STRING Name of the root element 20100602

Method CONVERT_TO_XML on class CL_XML_OPERATIONS has no exception.

Method CREATE_ROOT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing ATTR_LIST Call by reference Type reference (TYPE) ATTR_XML_T List of attributes 20100602
2 Importing DOCUMENT Call by reference Object reference (TYPE REF TO) IF_IXML_DOCUMENT Document reference 20100602
3 Importing ROOT Call by reference Type reference (TYPE) STRING Name of root element 20100602
4 Changing ROOT_ELEMENT Call by reference Object reference (TYPE REF TO) IF_IXML_ELEMENT Root element reference 20100602

Method CREATE_ROOT on class CL_XML_OPERATIONS has no exception.

Method CREATE_SCHEMA_DOCUMENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing DATA_TAB Call by reference Type reference (TYPE) STANDARD TABLE Data table for which to create the document 20100602
2 Changing DOCUMENT Call by reference Object reference (TYPE REF TO) IF_IXML_DOCUMENT Logical document 20100602
3 Importing FILESIZE Call by reference Type reference (TYPE) I File size 20100602
4 Exporting IS_OK Call by reference Type reference (TYPE) BOOLEAN Return code 20100602
5 Changing MSGLOG Call by reference Type reference (TYPE) STANDARD TABLE Message log 20100602
6 Importing SCHEMA Call by reference Type reference (TYPE) STRING Local file for upload/download 20100602

Method CREATE_SCHEMA_DOCUMENT on class CL_XML_OPERATIONS has no exception.

Method DELETE_OPTIONAL_CTYPE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing DELETE_PARENT Value transfer Type reference (TYPE) BOOLEAN Flag to delete the complextype 20100602
2 Changing INDEX Value transfer Type reference (TYPE) SY-TABIX Internal table, current line index 20100602
3 Changing NODES Call by reference Type reference (TYPE) NODE_XML_T List of nodes 20100602

Method DELETE_OPTIONAL_CTYPE on class CL_XML_OPERATIONS has no exception.

Method DELETE_OPTIONAL_NODE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing NODES Call by reference Type reference (TYPE) NODE_XML_T List of nodes 20100602

Method DELETE_OPTIONAL_NODE on class CL_XML_OPERATIONS has no exception.

Method EXPORT_TO_FILE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing DATA_TAB Call by reference Type reference (TYPE) STANDARD TABLE Data table to be downloaded in XML format 20100602
2 Changing FILENAME Call by reference Type reference (TYPE) STRING Name and path of download file 20100602
3 Importing FILESIZE Call by reference Type reference (TYPE) I Size of the download file 20100602
4 Exporting IS_OK Call by reference Type reference (TYPE) BOOLEAN Return code 20100602
5 Importing LOGFILENAME Call by reference Type reference (TYPE) FILEINTERN Logical file name 20121207
6 Changing MSGLOG Call by reference Type reference (TYPE) STANDARD TABLE Message log 20100602
7 Importing TO_APPSERVER Call by reference Type reference (TYPE) BOOLEAN SPACE Download to frontend or appserver 20100602

Method EXPORT_TO_FILE on class CL_XML_OPERATIONS has no exception.

Method GET_ENCODING Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing DOCUMENT Value transfer Object reference (TYPE REF TO) IF_IXML_DOCUMENT Document reference 20100602

Method GET_ENCODING on class CL_XML_OPERATIONS has no exception.

Method GET_NODES_FROM_DATA Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing ATTR_LIST Call by reference Type reference (TYPE) ATTR_XML_T Attributes of nodes of the XML file 20100602
2 Exporting IS_OK Call by reference Type reference (TYPE) BOOLEAN Return code 20100602
3 Importing I_NODE Call by reference Object reference (TYPE REF TO) IF_IXML_NODE Node reference 20100602
4 Changing MSGLOG Call by reference Type reference (TYPE) STANDARD TABLE Error message log 20100602
5 Changing NODE_LIST Call by reference Type reference (TYPE) NODE_XML_T Nodes of the XML file 20100602

Method GET_NODES_FROM_DATA on class CL_XML_OPERATIONS has no exception.

Method IMPORT_FROM_FILE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting DATA_TAB Call by reference Type reference (TYPE) STANDARD TABLE Data table 20100602
2 Importing FILENAME Call by reference Type reference (TYPE) STRING Schema file name 20100602
3 Exporting FILESIZE Call by reference Type reference (TYPE) I File size 20100602
4 Importing FROM_APPSERVER Call by reference Type reference (TYPE) BOOLEAN SPACE Upload from frontend or application server 20100602
5 Exporting IS_OK Call by reference Type reference (TYPE) BOOLEAN Return code 20100602
6 Importing LOGICAL_FILE_PATH Call by reference Type reference (TYPE) FILEINTERN Logical file name 20110610
7 Changing MSGLOG Call by reference Type reference (TYPE) STANDARD TABLE Messsage log 20100602

Method IMPORT_FROM_FILE on class CL_XML_OPERATIONS has no exception.

Method RENDER_XML_DOCUMENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing DOCUMENT Call by reference Object reference (TYPE REF TO) IF_IXML_DOCUMENT Document reference 20100602
2 Importing FILENAME Call by reference Type reference (TYPE) STRING Download file name 20100602
3 Changing FILESIZE Call by reference Type reference (TYPE) I Return file size 20100602
4 Importing IS_NORMALIZING Call by reference Type reference (TYPE) BOOLEAN TRUE Flag to check if normalizing parser should be created 20100602
5 Exporting IS_OK Call by reference Type reference (TYPE) BOOLEAN Return code 20100602
6 Changing MSGLOG Call by reference Type reference (TYPE) STANDARD TABLE Message log 20100602
7 Changing XML_DATA Call by reference Type reference (TYPE) STANDARD TABLE Converted XML data 20100602

Method RENDER_XML_DOCUMENT on class CL_XML_OPERATIONS has no exception.

Method SET_ENCODING Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing BYTE_ORDER Call by reference Type reference (TYPE) I BYTE_ORDER The byte order to use when representing characters 20100602
2 Importing CHARACTER_SET Call by reference Type reference (TYPE) STRING ENCODING The name of the character set for the encoding 20100602
3 Importing DOCUMENT Call by reference Object reference (TYPE REF TO) IF_IXML_DOCUMENT XML document reference 20100602
4 Exporting IS_OK Call by reference Type reference (TYPE) BOOLEAN Return code 20100602
5 Changing MSGLOG Call by reference Type reference (TYPE) STANDARD TABLE Message log 20100602

Method SET_ENCODING on class CL_XML_OPERATIONS has no exception.

Method VALIDATE_XML_FILE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing AT_APPSERVER Call by reference Type reference (TYPE) BOOLEAN SPACE Validation to be performed at frontend or appserver 20100602
2 Importing FILENAME Call by reference Type reference (TYPE) STRING Name of the XML file with path to be validated 20100602
3 Exporting IS_OK Call by reference Type reference (TYPE) BOOLEAN Return code 20100602
4 Changing MSGLOG Call by reference Type reference (TYPE) STANDARD TABLE Message log 20100602
5 Importing SCHEMA Call by reference Type reference (TYPE) STRING Name of the XML schema with path 20100602
6 Importing TARGET_NAMESPACE Call by reference Type reference (TYPE) STRING SPACE Name of the Target Namespace 20100602
# Exception Resumable Description Created on
1 NO_BATCH Validation cannot be executed in batch 20100602
History
Last changed by/on SAP  20130531 
SAP Release Created in 606