SAP ABAP Class CL_PCO_QUERY_XML_BUILDER (PCo Suite Integration: XML Builder for Query)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-SRV-PCO (Application Component) Plant Connectivity (Pco): ABAP part
⤷
S_PCO (Package) Plant Connectivity: Business Suite Integration (ABAP Part)
SAP_BASIS (Software Component) SAP Basis Component⤷
BC-SRV-PCO (Application Component) Plant Connectivity (Pco): ABAP part⤷
S_PCO (Package) Plant Connectivity: Business Suite Integration (ABAP Part)Properties
| Class | CL_PCO_QUERY_XML_BUILDER | |
| Short Description | PCo Suite Integration: XML Builder for Query | |
| Super Class | ||
| Instantiability of a Class | 1 | Protected |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | S_PCO | Plant Connectivity: Business Suite Integration (ABAP Part) |
| Created | 20100624 | SAP |
| Last change | 20130531 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
Class CL_PCO_QUERY_XML_BUILDER has no forward declaration.
Interfaces
Class CL_PCO_QUERY_XML_BUILDER has no interface implemented.
Friends
| # | Friend | Modeled only | Created on | Description |
|---|---|---|---|---|
| 1 | CL_PCO_QUERY | 20100723 | PCo: Superclass for PCo Queries |
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | GC_A_PCO_MASK |
Constant | Protected | Type reference (TYPE) | STRING | 'pco:mask' | Attribute for Search Template (DB Query) | 20100721 | |
| 2 | GC_A_PCO_QL_VERSION |
Constant | Protected | Type reference (TYPE) | STRING | 'pco:version' | Version PCo Query Language | 20100626 | |
| 3 | GC_A_PCO_TABLE |
Constant | Protected | Type reference (TYPE) | STRING | 'pco:table' | Attribute for Database Table (DB Query) | 20100721 | |
| 4 | GC_A_PREFIX_PCO |
Constant | Protected | Type reference (TYPE) | STRING | 'pco' | PCo Prefix | 20100626 | |
| 5 | GC_A_URI_PCO_REQUEST |
Constant | Protected | Type reference (TYPE) | STRING | 'uri:sap-pco-request' | URI for PCo Request | 20100626 | |
| 6 | GC_A_XMLNS_PCO |
Constant | Protected | Type reference (TYPE) | STRING | 'xmlns:pco' | XML Namespace | 20100626 | |
| 7 | GC_REQ_TYPE_DB |
Constant | Public | Type reference (TYPE) | S_PCO_REQUEST_TYPE | 'database' | Request Type Database Query | 20100630 | |
| 8 | GC_REQ_TYPE_FEAT |
Constant | Public | Type reference (TYPE) | S_PCO_REQUEST_TYPE | 'features' | Request Type Features Query | 20100630 | |
| 9 | GC_REQ_TYPE_TAG |
Constant | Public | Type reference (TYPE) | S_PCO_REQUEST_TYPE | 'tag' | Request Type Tag Query | 20100630 | |
| 10 | GC_REQ_TYPE_TEXT |
Constant | Public | Type reference (TYPE) | S_PCO_REQUEST_TYPE | 'text' | Request Type Text Query | 20100630 | |
| 11 | GC_T_PCO_COLUMNS |
Constant | Public | Type reference (TYPE) | STRING | 'columns' | Element Tag Name for Table Columns (DB Query) | 20100721 | |
| 12 | GC_T_PCO_DATABASE |
Constant | Protected | Type reference (TYPE) | STRING | 'database' | Element Tag Name for Database (DB Query) | 20100721 | |
| 13 | GC_T_PCO_QUERY |
Constant | Public | Type reference (TYPE) | STRING | 'query' | Element Tag Name for Query (DB Query) | 20100721 | |
| 14 | GC_T_PCO_REQUEST |
Constant | Protected | Type reference (TYPE) | STRING | 'request' | Element Tag Name for Request | 20100626 | |
| 15 | GC_T_PCO_TABLES |
Constant | Public | Type reference (TYPE) | STRING | 'tables' | Tables (DB Query) | 20100721 | |
| 16 | M_CURRENT |
Instance attribute | Protected | Object reference (TYPE REF TO) | IF_IXML_NODE | Current XML Element Object (iXML) | 20100626 | ||
| 17 | M_DOCUMENT |
Instance attribute | Protected | Object reference (TYPE REF TO) | IF_IXML_DOCUMENT | XML Document Object (iXML) | 20100626 | ||
| 18 | M_ELEMENT |
Instance attribute | Protected | Object reference (TYPE REF TO) | IF_IXML_ELEMENT | XML Element Object (iXML) | 20100626 | ||
| 19 | M_IXML |
Instance attribute | Protected | Object reference (TYPE REF TO) | IF_IXML | iXML Object (iXML) | 20100626 | ||
| 20 | M_PARENT |
Instance attribute | Protected | Object reference (TYPE REF TO) | IF_IXML_NODE | Parent Element Object (iXML) | 20100626 | ||
| 21 | M_PCO_DB_ELEMENT |
Instance attribute | Protected | Object reference (TYPE REF TO) | IF_IXML_ELEMENT | Element Object for PCo DB Query (iXML) | 20100721 | ||
| 22 | M_PCO_QL_VERSION |
Instance attribute | Private | Type reference (TYPE) | STRING | '1.0' | Version of PCo Query Language | 20100726 | |
| 23 | M_PCO_REQUEST |
Instance attribute | Protected | Object reference (TYPE REF TO) | IF_IXML_ELEMENT | Element Object for PCo Request (iXML) | 20100626 | ||
| 24 | M_PCO_REQ_CONTENT |
Instance attribute | Protected | Object reference (TYPE REF TO) | IF_IXML_ELEMENT | Element Object for PCo Query Content (iXML) | 20100626 | ||
| 25 | M_STREAM_FACTORY |
Instance attribute | Protected | Object reference (TYPE REF TO) | IF_IXML_STREAM_FACTORY | IStream Factory Object (iXML) | 20100626 | ||
| 26 | M_VALUE |
Instance attribute | Protected | Type reference (TYPE) | STRING | Element/Attribute Value (iXML) | 20100626 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | BUILD_DB_QUERY_XML_DOC |
Instance method | Public | Method | Generates XML File for Database Queries | 20100721 |
| 2 | BUILD_QUERY_XML_DOC |
Instance method | Public | Method | Generates XML File for PCo Queries | 20100721 |
| 3 | CONSTRUCTOR |
Instance method | Public | Constructor | CONSTRUCTOR | 20100626 |
| 4 | CONVERT_XML_DOC_TO_STRING |
Instance method | Protected | Method | Conversion of XML Object Contents into String/XString Format | 20100721 |
| 5 | CREATE_ATTRIBUTE |
Instance method | Protected | Method | Generates Attribute for XML Element | 20100626 |
| 6 | CREATE_DB_QUERY_CONTENT |
Instance method | Protected | Method | Generates Attribute for Database Queries | 20100721 |
| 7 | CREATE_PCO_QUERY_CONTENT |
Instance method | Protected | Method | Generates Content of a PCo Query Request | 20100721 |
| 8 | CREATE_PCO_REQUEST_ELEMENT |
Instance method | Protected | Method | Generates PCo Element | 20100721 |
| 9 | CREATE_XML_HEADER |
Instance method | Protected | Method | Generates Header Data of an XML Document for PCo Query | 20100721 |
Events
Class CL_PCO_QUERY_XML_BUILDER has no event.
Types
Class CL_PCO_QUERY_XML_BUILDER has no local type.
Method Signatures
Method BUILD_DB_QUERY_XML_DOC Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
EV_XML_STRING | Call by reference | Type reference (TYPE) | STRING | XML-Dokument als String | 20100721 | ||
| 2 | Exporting |
EV_XML_XSTRING | Call by reference | Type reference (TYPE) | XSTRING | XML-Dokument als XString | 20100721 | ||
| 3 |  Importing |
IV_CHILD_TAG_NAME | Call by reference | Type reference (TYPE) | STRING | Name des Kindelements | 20100721 | ||
| 4 | Importing |
IV_DB_TAB_NAME | Call by reference | Type reference (TYPE) | S_PCO_DB_TAB_NAME | PCo: Name Datenbanktabelle | 20100721 | ||
| 5 | Importing |
IV_QUERY_CONTENT | Call by reference | Type reference (TYPE) | STRING | Inhalt der Query | 20100721 | ||
| 6 | Importing |
IV_SEARCH_MASK | Call by reference | Type reference (TYPE) | S_PCO_SEARCH_MASK | PCo: Maskierungshilfe bei Suche | 20100721 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CX_PCO_BS_INT |
PCo Suite Integration: Ausnahmeklasse | 20100827 |
Method BUILD_QUERY_XML_DOC Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
EV_XML_STRING | Call by reference | Type reference (TYPE) | STRING | XML-Dokument als String | 20100721 | ||
| 2 | Exporting |
EV_XML_XSTRING | Call by reference | Type reference (TYPE) | XSTRING | XML-Dokument als XString | 20100721 | ||
| 3 | Importing |
IV_PCO_QL_VERSION | Call by reference | Type reference (TYPE) | STRING | '1.0' | Version PCo Querysprache | 20100726 | |
| 4 | Importing |
IV_QUERY_CONTENT | Call by reference | Type reference (TYPE) | STRING | Inhalt der Query | 20100721 | ||
| 5 | Importing |
IV_REQUEST_TYPE | Call by reference | Type reference (TYPE) | S_PCO_REQUEST_TYPE | Requesttyp (Tag, Text, Features) | 20100721 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_PCO_BS_INT |
20100827 |
Method CONSTRUCTOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_PCO_QL_VERSION | Call by reference | Type reference (TYPE) | S_PCO_QUERY_LANG_VERSION | '1.0' | Version PCo Querysprache | 20100726 |
Method CONSTRUCTOR on class CL_PCO_QUERY_XML_BUILDER has no exception.
Method CONVERT_XML_DOC_TO_STRING Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
EV_XML_STRING | Call by reference | Type reference (TYPE) | STRING | XML-Dokument als String | 20100721 | ||
| 2 | Exporting |
EV_XML_XSTRING | Call by reference | Type reference (TYPE) | XSTRING | XML-Dokument als XString | 20100721 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_PCO_BS_INT |
20100827 |
Method CREATE_ATTRIBUTE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IO_ELEMENT | Call by reference | Object reference (TYPE REF TO) | IF_IXML_ELEMENT | IF_IXML_ELEMENT | 20100626 | ||
| 2 | Importing |
IV_NAME | Call by reference | Type reference (TYPE) | STRING | Attributname | 20100626 | ||
| 3 | Importing |
IV_VALUE | Call by reference | Type reference (TYPE) | STRING | Attributswert | 20100626 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_PCO_BS_INT |
20100827 |
Method CREATE_DB_QUERY_CONTENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_CHILD_TAG_NAME | Call by reference | Type reference (TYPE) | STRING | Name des Kindelements | 20100721 | ||
| 2 | Importing |
IV_DB_TAB_NAME | Call by reference | Type reference (TYPE) | S_PCO_DB_TAB_NAME | PCo: Name Datenbanktabelle | 20100721 | ||
| 3 | Importing |
IV_QUERY_CONTENT | Call by reference | Type reference (TYPE) | STRING | Inhalt der Query | 20100721 | ||
| 4 | Importing |
IV_SEARCH_MASK | Call by reference | Type reference (TYPE) | S_PCO_SEARCH_MASK | PCo: Maskierungshilfe bei Suche | 20100721 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_PCO_BS_INT |
20100827 |
Method CREATE_PCO_QUERY_CONTENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_QUERY_CONTENT | Call by reference | Type reference (TYPE) | STRING | Inhalt der Query | 20100721 | ||
| 2 | Importing |
IV_REQUEST_TYPE | Call by reference | Type reference (TYPE) | S_PCO_REQUEST_TYPE | Requesttyp (Tag, Text, Features) | 20100721 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_PCO_BS_INT |
20100827 |
Method CREATE_PCO_REQUEST_ELEMENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_PCO_QL_VERSION | Call by reference | Type reference (TYPE) | STRING | '1.0' | Version PCo Querysprache | 20100726 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_PCO_BS_INT |
20100827 |
Method CREATE_XML_HEADER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_PCO_QL_VERSION | Call by reference | Type reference (TYPE) | STRING | '1.0' | Version PCo Querysprache | 20100726 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_PCO_BS_INT |
20100827 |
History
| Last changed by/on | SAP | 20130531 |
| SAP Release Created in | 703 |
