SAP ABAP Class CL_WAPI_WEBFLOW_XML_REQUEST (Workflow: API for XML Requests)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-BMT-WFM (Application Component) SAP Business Workflow
⤷
SWF_XML (Package) Workflow: XML
⤷
⤷
Properties
| Class | CL_WAPI_WEBFLOW_XML_REQUEST | |
| Short Description | Workflow: API for XML Requests | |
| Super Class | ||
| Instantiability of a Class | 0 | Private |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | SWF_XML | Workflow: XML |
| Created | 20011207 | SAP |
| Last change | 20110908 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 | Forward declaration class (CLASS c DEFINITION DEFERRED) | Forward declaration class (CLASS c DEFINITION DEFERRED) | |
| 2 | Forward declaration class (CLASS c DEFINITION DEFERRED) | Forward declaration class (CLASS c DEFINITION DEFERRED) |
Interfaces
Class CL_WAPI_WEBFLOW_XML_REQUEST has no interface implemented.
Friends
Class CL_WAPI_WEBFLOW_XML_REQUEST has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Constant | Public | Type reference (TYPE) | SWFDNAME | 'WfXML_Name' | Element: WF-XML Name | 20011210 | ||
| 2 | Constant | Public | Type reference (TYPE) | SWFDNAME | 'WfXML_Status' | Element: WF-XML Status | 20011210 | ||
| 3 | Constant | Public | Type reference (TYPE) | SWFDNAME | 'WfXML_Subject' | Element: WF-XML Subject | 20011210 | ||
| 4 | Constant | Public | Type reference (TYPE) | STRING | 'LOCAL_URL' | Property: Local URL | 20011207 | ||
| 5 | Constant | Public | Type reference (TYPE) | STRING | 'SAVE_DOCUMENTS' | Property: Save XML Documents | 20011210 | ||
| 6 | Constant | Public | Type reference (TYPE) | STRING | 'TARGET_URL' | Property: Target URL | 20011207 | ||
| 7 | Constant | Public | Type reference (TYPE) | STRING | 'WORKITEM_ID' | Property: Work Item ID | 20011207 | ||
| 8 | Constant | Public | Type reference (TYPE) | STRING | '01' | Protocol: WF-XML Version 0.9 | 20011210 | ||
| 9 | Constant | Public | Type reference (TYPE) | STRING | '03' | Protocol: WF-XML Version 1.0 | 20011210 | ||
| 10 | Constant | Public | Type reference (TYPE) | STRING | 'CPIS' | Function: Change Status | 20011210 | ||
| 11 | Constant | Public | Type reference (TYPE) | STRING | 'CPI' | Function: Start Proces | 20011210 | ||
| 12 | Constant | Public | Type reference (TYPE) | STRING | 'GPID' | Function: Read Process Data | 20011210 | ||
| 13 | Constant | Public | Type reference (TYPE) | STRING | 'PISC' | Function: Status Changed | 20011210 | ||
| 14 | Instance attribute | Private | Type reference (TYPE) | STRING | 20011207 | ||||
| 15 | Instance attribute | Private | Object reference (TYPE REF TO) | IF_SWF_CNT_CONTAINER | 20011207 | ||||
| 16 | Instance attribute | Public | Type reference (TYPE) | STRING | Log ID | 20011207 | |||
| 17 | Instance attribute | Private | Type reference (TYPE) | SWD_XMLPRT | 20011207 | ||||
| 18 | Instance attribute | Private | Object reference (TYPE REF TO) | IF_SWF_CNT_CONTAINER | 20011207 | ||||
| 19 | Instance attribute | Private | Object reference (TYPE REF TO) | IF_SWF_XML_REQUEST_SEND | 20011207 | ||||
| 20 | Instance attribute | Public | Type reference (TYPE) | STRING | Operation | 20011207 | |||
| 21 | Instance attribute | Private | Type reference (TYPE) | XFELD | 20011210 | ||||
| 22 | Instance attribute | Private | Type reference (TYPE) | STRING | 20011207 | ||||
| 23 | Instance attribute | Private | Type reference (TYPE) | SWW_WIID | 20011207 | ||||
| 24 | Instance attribute | Public | Object reference (TYPE REF TO) | CL_XML_DOCUMENT | XML Request | 20011207 | |||
| 25 | Instance attribute | Public | Object reference (TYPE REF TO) | IF_IXML_NODE | 20011207 | ||||
| 26 | Instance attribute | Public | Object reference (TYPE REF TO) | CL_XML_DOCUMENT | XML Response | 20011207 | |||
| 27 | Instance attribute | Public | Object reference (TYPE REF TO) | IF_IXML_NODE | 20011207 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Public | Constructor | Constructor | 20011207 | |
| 2 | Instance method | Public | Method | Generates XML Request | 20011207 | |
| 3 | Static method | Public | Method | Delivers an Instance | 20011207 | |
| 4 | Instance method | Public | Method | Gets Values of Property (Context) | 20011207 | |
| 5 | Instance method | Public | Method | Gets Container for Protocol-Specific Data | 20011207 | |
| 6 | Instance method | Public | Method | Gets (Reference) Container for Application Data | 20011207 | |
| 7 | Instance method | Public | Method | Processes XML Response | 20011207 | |
| 8 | Instance method | Public | Method | Sends XML Request Using HTTP POST | 20011207 | |
| 9 | Instance method | Private | Method | 20011210 | ||
| 10 | Instance method | Public | Method | Sets Value of a Property (Context) | 20011207 | |
| 11 | Instance method | Public | Method | Sets (Reference) Container for Application Data | 20011207 | |
| 12 | Instance method | Public | Method | Sets XML Response Document | 20011207 |
Events
Class CL_WAPI_WEBFLOW_XML_REQUEST has no event.
Types
Class CL_WAPI_WEBFLOW_XML_REQUEST has no local type.
Method Signatures
Method CONSTRUCTOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IM_PROTOCOL_ID | Call by reference | Type reference (TYPE) | STRING | 20011207 | ||||
| 2 | IM_REQUEST_TYPE | Call by reference | Type reference (TYPE) | STRING | 20011207 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Workflow-WAPI: Ausnahme | 20011207 |
Method CREATE_XML_REQUEST Signature
Method CREATE_XML_REQUEST on class CL_WAPI_WEBFLOW_XML_REQUEST has no parameter.
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Workflow-WAPI: Ausnahme | 20011207 |
Method GET_INSTANCE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IM_PROTOCOL_ID | Call by reference | Type reference (TYPE) | STRING | Protokoll-ID | 20011207 | |||
| 2 | IM_REQUEST_TYPE | Call by reference | Type reference (TYPE) | STRING | Operation | 20011207 | |||
| 3 | RE_INSTANCE | Value transfer | Object reference (TYPE REF TO) | CL_WAPI_WEBFLOW_XML_REQUEST | Workflow: API für XML-Requests | 20011207 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Workflow-WAPI: Ausnahme | 20011207 |
Method GET_PROPERTY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IM_PROPERTY | Call by reference | Type reference (TYPE) | STRING | 20011207 | ||||
| 2 | RE_VALUE | Value transfer | Type reference (TYPE) | STRING | 20011207 |
Method GET_PROPERTY on class CL_WAPI_WEBFLOW_XML_REQUEST has no exception.
Method GET_PROTOCOL_CONTAINER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RE_CONTAINER | Value transfer | Object reference (TYPE REF TO) | IF_SWF_IFS_PARAMETER_CONTAINER | Protokoll Container | 20011207 |
Method GET_PROTOCOL_CONTAINER on class CL_WAPI_WEBFLOW_XML_REQUEST has no exception.
Method GET_REFERENCE_CONTAINER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IM_CREATE | Call by reference | Type reference (TYPE) | XFELD | SPACE | 'X' = Neu erzeugen | 20011207 | ||
| 2 | IM_TASK | Call by reference | Type reference (TYPE) | SWR_TASK | WAPI: Aufgaben | 20011207 | |||
| 3 | RE_CONTAINER | Value transfer | Object reference (TYPE REF TO) | IF_SWF_IFS_PARAMETER_CONTAINER | Container | 20011207 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Workflow-WAPI: Ausnahme | 20011207 |
Method HANDLE_XML_RESPONSE Signature
Method HANDLE_XML_RESPONSE on class CL_WAPI_WEBFLOW_XML_REQUEST has no parameter.
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Workflow-WAPI: Ausnahme | 20011207 |
Method HTTP_POST_XML_REQUEST Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IM_PASSWORD | Call by reference | Type reference (TYPE) | STRING | 20011207 | ||||
| 2 | IM_USER | Call by reference | Type reference (TYPE) | STRING | 20011207 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Workflow-WAPI: Ausnahme | 20011207 |
Method SAVE_XML_DOCUMENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IM_XML_DOCUMENT | Call by reference | Object reference (TYPE REF TO) | CL_XML_DOCUMENT | 20011210 |
Method SAVE_XML_DOCUMENT on class CL_WAPI_WEBFLOW_XML_REQUEST has no exception.
Method SET_PROPERTY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IM_PROPERTY | Call by reference | Type reference (TYPE) | STRING | 20011207 | ||||
| 2 | IM_VALUE | Call by reference | Type reference (TYPE) | STRING | 20011207 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Workflow-WAPI: Ausnahme | 20011207 |
Method SET_REFERENCE_CONTAINER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IM_CONTAINER | Call by reference | Object reference (TYPE REF TO) | IF_SWF_IFS_PARAMETER_CONTAINER | 20011207 |
Method SET_REFERENCE_CONTAINER on class CL_WAPI_WEBFLOW_XML_REQUEST has no exception.
Method SET_XML_RESPONSE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IM_DOCUMENT | Call by reference | Object reference (TYPE REF TO) | CL_XML_DOCUMENT | 20011207 |
Method SET_XML_RESPONSE on class CL_WAPI_WEBFLOW_XML_REQUEST has no exception.
History
| Last changed by/on | SAP | 20110908 |
| SAP Release Created in | 620 |