SAP ABAP Class CL_IDOC_XML1 (IDocs in XML Format)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-MID-ALE (Application Component) ALE Integration Technology
⤷
SXML1 (Package) Services for IDoc/XML Processing
SAP_BASIS (Software Component) SAP Basis Component⤷
BC-MID-ALE (Application Component) ALE Integration Technology⤷
SXML1 (Package) Services for IDoc/XML ProcessingProperties
| Class | CL_IDOC_XML1 | |
| Short Description | IDocs in XML Format | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | SXML1 | Services for IDoc/XML Processing |
| Created | 19990721 | SAP |
| Last change | 20090618 | 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) |
Interfaces
Class CL_IDOC_XML1 has no interface implemented.
Friends
Class CL_IDOC_XML1 has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CONTROL_RECORD |
Instance attribute | Private | Type reference (TYPE) | EDIDC | Control Record | 19991027 | ||
| 2 | IDOC_DATA |
Instance attribute | Private | Type reference (TYPE) | STRING | IDoc as String in XML Format | 19990721 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | CONSTRUCTOR |
Instance method | Public | Constructor | Constructor | 19990721 |
| 2 | CREATE_TRANSFORM_NEW |
Instance method | Public | Method | Creates New Transformation and Generates New View | 20011031 |
| 3 | CREATE_VIEW |
Instance method | Public | Method | Generates a View of the IDoc | 19990721 |
| 4 | DO_AUTHORITY_CHECK |
Instance method | Private | Method | Checks the Authorization of the User | 19991111 |
| 5 | GET_CONTROLRECORD |
Instance method | Public | Method | IDoc Control Record | 19991027 |
| 6 | GET_XMLDATA_AS_STRING |
Instance method | Public | Method | IDoc in XML Format in String of Type C | 20000410 |
| 7 | GET_XMLDATA_AS_TABLE |
Instance method | Public | Method | IDoc in XML Format in Table of Type C | 20000411 |
| 8 | GET_XMLDATA_AS_XSTRING |
Instance method | Public | Method | IDoc in XML Format in String of Type X | 20000411 |
| 9 | GET_XMLDATA_AS_XTABLE |
Instance method | Public | Method | IDoc in XML Format in Table of Type X | 20000411 |
Events
Class CL_IDOC_XML1 has no event.
Types
Class CL_IDOC_XML1 has no local type.
Method Signatures
Method CONSTRUCTOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
DOCNUM | Call by reference | Type reference (TYPE) | EDI_DOCNUM | IDocnummer | 19990721 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  ERROR_BUILDING_XML |
Fehler beim Aufbau des XML-Formats | 19991216 | |
| 2 | ERROR_LOADING_IDOC |
Fehler beim Lesen des IDocs von der Datenbank | 19991117 |
Method CREATE_TRANSFORM_NEW Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IDOC | Call by reference | Object reference (TYPE REF TO) | CL_IDOC_XML1 | IDocs in XML-Format | 20011031 | ||
| 2 | Importing |
PROGRAM | Call by reference | Type reference (TYPE) | CXSLTDESC | Name eines XSLT-Programms | 20011031 | ||
| 3 | Importing |
STYLE_ID | Call by reference | Type reference (TYPE) | EDI_STYLE | Style-ID | 20011031 |
Method CREATE_TRANSFORM_NEW on class CL_IDOC_XML1 has no exception.
Method CREATE_VIEW Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
PARENT | Call by reference | Object reference (TYPE REF TO) | CL_GUI_CONTAINER | Parent Container der Sicht | 19990721 | ||
| 2 |  Returning |
VIEW | Value transfer | Object reference (TYPE REF TO) | CL_IDOC_XML1_VIEW | Instanz der erzeugten Sicht | 19990721 | ||
| 3 | Importing |
XSLID | Call by reference | Type reference (TYPE) | EDI_STYLE | ID des Stylesheets | 19990721 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | ERROR_CREATING_VIEW |
Fehler beim Erzeugen der Anzeige | 19991116 | |
| 2 | NO_DISPLAY_AUTHORITY |
keine Berechtigung zur Anzeige des IDocs | 19991111 |
Method DO_AUTHORITY_CHECK Signature
Method DO_AUTHORITY_CHECK on class CL_IDOC_XML1 has no parameter.
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | NO_DISPLAY_AUTHORITY |
keine Berechtigung zur Anzeige des IDocs | 19991111 |
Method GET_CONTROLRECORD Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
CONTROLRECORD | Value transfer | Type reference (TYPE) | EDIDC | Kontrollsatz des IDocs | 19991027 |
Method GET_CONTROLRECORD on class CL_IDOC_XML1 has no exception.
Method GET_XMLDATA_AS_STRING Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
DATA_STRING | Call by reference | Type reference (TYPE) | STRING | IDoc in XML-Format | 20000410 | ||
| 2 | Exporting |
LEN | Call by reference | Type reference (TYPE) | I | Länge des Strings | 20000411 |
Method GET_XMLDATA_AS_STRING on class CL_IDOC_XML1 has no exception.
Method GET_XMLDATA_AS_TABLE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
DATA_TABLE | Call by reference | Type reference (TYPE) | TAB_CHAR512 | IDoc in XML-Format | 20000411 | ||
| 2 | Exporting |
LEN | Call by reference | Type reference (TYPE) | I | Länge der Tabelle | 20000411 |
Method GET_XMLDATA_AS_TABLE on class CL_IDOC_XML1 has no exception.
Method GET_XMLDATA_AS_XSTRING Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
DATA_STRING | Call by reference | Type reference (TYPE) | XSTRING | IDoc in XML-Format | 20000411 | ||
| 2 | Importing |
ENCODING | Call by reference | Type reference (TYPE) | ABAP_ENCODING | 'DEFAULT' | Eingabezeichenformat | 20000411 | |
| 3 | Importing |
ENDIAN | Call by reference | Type reference (TYPE) | ABAP_ENDIAN | Eingabebytereihenfolge | 20000411 | ||
| 4 | Importing |
IGNORE_CERR | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Flag: Ignoriere Fehler bei Zeichensatzkonvertierung | 20000411 | |
| 5 | Exporting |
LEN | Call by reference | Type reference (TYPE) | I | Länge des Strings | 20000411 | ||
| 6 | Importing |
REPLACEMENT | Call by reference | Type reference (TYPE) | ABAP_REPL | '#' | Ersetzungszeichen/-string für Zeichensatzkonvertierung | 20000411 |
Method GET_XMLDATA_AS_XSTRING on class CL_IDOC_XML1 has no exception.
Method GET_XMLDATA_AS_XTABLE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
DATA_TABLE | Call by reference | Type reference (TYPE) | TAB_RAW512 | IDoc in XML-Format | 20000411 | ||
| 2 | Importing |
ENCODING | Call by reference | Type reference (TYPE) | ABAP_ENCODING | 'DEFAULT' | Eingabezeichenformat | 20000411 | |
| 3 | Importing |
ENDIAN | Call by reference | Type reference (TYPE) | ABAP_ENDIAN | Eingabebytereihenfolge | 20000411 | ||
| 4 | Importing |
IGNORE_CERR | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Flag: Ignoriere Fehler bei Zeichensatzkonvertierung | 20000411 | |
| 5 | Exporting |
LEN | Call by reference | Type reference (TYPE) | I | Länge der Tabelle | 20000411 | ||
| 6 | Importing |
REPLACEMENT | Call by reference | Type reference (TYPE) | ABAP_REPL | '#' | Ersetzungszeichen/-string für Zeichensatzkonvertierung | 20000411 |
Method GET_XMLDATA_AS_XTABLE on class CL_IDOC_XML1 has no exception.
History
| Last changed by/on | SAP | 20090618 |
| SAP Release Created in |
