SAP ABAP Class CL_SWF_API_BASE_HANDLER (Workflow-API: Basis Handler Class)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-BMT-WFM (Application Component) SAP Business Workflow
⤷
SWF_API (Package) Workflow API / XML Interface
SAP_BASIS (Software Component) SAP Basis Component⤷
BC-BMT-WFM (Application Component) SAP Business Workflow⤷
SWF_API (Package) Workflow API / XML InterfaceMeta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Inheritance (c INHERITING FROM c_ref) | CL_SWF_GET_BPML | Workflow-API: Basis Handler Class | 20010917 |
| 2 | Inheritance (c INHERITING FROM c_ref) | CL_SWF_GET_CONTAINER | Workflow-API: Basis Handler Class | 20010518 |
| 3 | Inheritance (c INHERITING FROM c_ref) | CL_SWF_START_WORKFLOW | Workflow-API: Basis Handler Class | 20010515 |
Properties
| Class | CL_SWF_API_BASE_HANDLER | |
| Short Description | Workflow-API: Basis Handler Class | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | P | SAP Standard Production Program |
| Category | 0 | |
| Package | SWF_API | Workflow API / XML Interface |
| Created | 20010515 | SAP |
| Last change | 20110908 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
Class CL_SWF_API_BASE_HANDLER has no forward declaration.
Interfaces
Class CL_SWF_API_BASE_HANDLER has no interface implemented.
Friends
Class CL_SWF_API_BASE_HANDLER has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | C_TAG_EXCEPTION |
Constant | Public | Type reference (TYPE) | STRING | 'exception' | 20010517 | ||
| 2 | C_TAG_EXCEPT_TYPE |
Constant | Public | Type reference (TYPE) | STRING | 'type' | 20010517 | ||
| 3 | C_TAG_EXPORT_DATA |
Constant | Public | Type reference (TYPE) | STRING | 'export_data' | 20010517 | ||
| 4 | C_TAG_HEADER |
Constant | Public | Type reference (TYPE) | STRING | 'global_data' | 20010518 | ||
| 5 | C_TAG_IMPORT_DATA |
Constant | Public | Type reference (TYPE) | STRING | 'import_data' | 20010517 | ||
| 6 | C_TAG_NAME |
Constant | Public | Type reference (TYPE) | STRING | 'name' | 20010601 | ||
| 7 | C_TAG_REQUEST |
Constant | Public | Type reference (TYPE) | STRING | 'request' | 20010516 | ||
| 8 | C_TAG_RESPONSE |
Constant | Public | Type reference (TYPE) | STRING | 'response' | 20010516 | ||
| 9 | C_TAG_ROOT |
Constant | Public | Type reference (TYPE) | STRING | 'SAP-WORKFLOW-API' | 20010516 | ||
| 10 | C_TAG_VERSION |
Constant | Public | Type reference (TYPE) | STRING | 'version' | 20010516 | ||
| 11 | M_EXPORT_DOC |
Instance attribute | Protected | Object reference (TYPE REF TO) | CL_XML_DOCUMENT_BASE | XML Document - Management (Basis Class) | 20010516 | ||
| 12 | M_GLOBALS |
Instance attribute | Protected | Type reference (TYPE) | SAPI_SHEAD | Workflow API: Header Structure | 20010516 | ||
| 13 | M_IMPORT_DOC |
Instance attribute | Protected | Object reference (TYPE REF TO) | CL_XML_DOCUMENT_BASE | XML Document - Management (Basis Class) | 20010516 | ||
| 14 | M_NODE_EXCEPTION |
Instance attribute | Protected | Object reference (TYPE REF TO) | IF_IXML_NODE | IF_IXML_NODE | 20010521 | ||
| 15 | M_NODE_EXPORT_DATA |
Instance attribute | Protected | Object reference (TYPE REF TO) | IF_IXML_NODE | IF_IXML_NODE | 20010521 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | CONSTRUCTOR |
Instance method | Public | Constructor | Constructor | 20010516 |
| 2 | CREATE |
Static method | Public | Method | Creates Handler Object from Name | 20010516 |
| 3 | EXECUTE |
Instance method | Public | Method | Execute | 20010515 |
| 4 | GET_IMPORT_DATA |
Instance method | Protected | Method | Gets Data Element from IMPORT XML Document | 20010516 |
| 5 | SET_DOCUMENTS |
Instance method | Public | Method | Set Import/Export Documents, Global Daten | 20010518 |
| 6 | SET_EXPORT_DATA |
Instance method | Protected | Method | Sets a Data Element to the EXPORT XML Document | 20010516 |
| 7 | SET_MESSAGE |
Static method | Public | Method | Sets a Message Structure to an XML Document | 20010516 |
| 8 | _SET_SY_MESSAGE |
Instance method | Protected | Method | 20010522 | |
| 9 | _SET_WAPI_MESSAGES |
Instance method | Protected | Method | 20010522 |
Events
Class CL_SWF_API_BASE_HANDLER has no event.
Types
Class CL_SWF_API_BASE_HANDLER has no local type.
Method Signatures
Method CONSTRUCTOR Signature
Method CONSTRUCTOR on class CL_SWF_API_BASE_HANDLER has no parameter.
Method CONSTRUCTOR on class CL_SWF_API_BASE_HANDLER has no exception.
Method CREATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
EXPORT_DOC | Call by reference | Object reference (TYPE REF TO) | CL_XML_DOCUMENT_BASE | XML-Dokument -Verwaltung (Basisklasse) | 20010516 | ||
| 2 | Importing |
HANDLER_NAME | Call by reference | Type reference (TYPE) | STRING | Name der Handlerklasse | 20010516 | ||
| 3 |  Returning |
HANDLER_OBJECT | Value transfer | Object reference (TYPE REF TO) | CL_SWF_API_BASE_HANDLER | Workflow-API: Basis-Handler-Klasse | 20010516 | ||
| 4 | Importing |
IMPORT_DOC | Call by reference | Object reference (TYPE REF TO) | CL_XML_DOCUMENT_BASE | XML-Dokument -Verwaltung (Basisklasse) | 20010516 |
Method CREATE on class CL_SWF_API_BASE_HANDLER has no exception.
Method EXECUTE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RETCODE | Value transfer | Type reference (TYPE) | SYSUBRC | 20010516 |
Method EXECUTE on class CL_SWF_API_BASE_HANDLER has no exception.
Method GET_IMPORT_DATA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
DATA | Call by reference | Type reference (TYPE) | ANY | Datenfeld/-struktur die gefüllt wird | 20010516 | ||
| 2 | Importing |
NAME | Call by reference | Type reference (TYPE) | STRING | Name des Elements | 20010516 | ||
| 3 | Exporting |
RETCODE | Call by reference | Type reference (TYPE) | SYSUBRC | Rückgabewert, Rückgabewert nach ABAP-Anweisungen | 20010516 |
Method GET_IMPORT_DATA on class CL_SWF_API_BASE_HANDLER has no exception.
Method SET_DOCUMENTS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
EXPORT_DOC | Call by reference | Object reference (TYPE REF TO) | CL_XML_DOCUMENT_BASE | XML-Dokument -Verwaltung (Basisklasse) | 20010518 | ||
| 2 | Importing |
IMPORT_DOC | Call by reference | Object reference (TYPE REF TO) | CL_XML_DOCUMENT_BASE | XML-Dokument -Verwaltung (Basisklasse) | 20010518 |
Method SET_DOCUMENTS on class CL_SWF_API_BASE_HANDLER has no exception.
Method SET_EXPORT_DATA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
DATA | Call by reference | Type reference (TYPE) | ANY | Datenfeld/-struktur die gesetzt wird | 20010516 | ||
| 2 | Importing |
NAME | Call by reference | Type reference (TYPE) | STRING | Name des Elements | 20010516 | ||
| 3 | Returning |
RETCODE | Value transfer | Type reference (TYPE) | SYSUBRC | Rückgabewert, Rückgabewert nach ABAP-Anweisungen | 20010516 |
Method SET_EXPORT_DATA on class CL_SWF_API_BASE_HANDLER has no exception.
Method SET_MESSAGE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
DOCUMENT | Call by reference | Object reference (TYPE REF TO) | CL_XML_DOCUMENT_BASE | XML-Dokument -Verwaltung (Basisklasse) | 20010516 | ||
| 2 | Importing |
MSG | Call by reference | Type reference (TYPE) | SAPI_SMSG | Workflow-API: Message-Struktur | 20010516 | ||
| 3 | Returning |
RETCODE | Value transfer | Type reference (TYPE) | SYSUBRC | Rückgabewert, Rückgabewert nach ABAP-Anweisungen | 20010516 |
Method SET_MESSAGE on class CL_SWF_API_BASE_HANDLER has no exception.
Method _SET_SY_MESSAGE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
MESSAGE | Call by reference | Type reference (TYPE) | C | SPACE | 20010522 | ||
| 2 | Importing |
MSGID | Call by reference | Type reference (TYPE) | SYMSGID | SY-MSGID | Nachrichten, Nachrichtenklasse | 20010522 | |
| 3 | Importing |
MSGNO | Call by reference | Type reference (TYPE) | SYMSGNO | SY-MSGNO | 20010522 | ||
| 4 | Importing |
MSGTY | Call by reference | Type reference (TYPE) | SYMSGTY | SY-MSGTY | 20010522 | ||
| 5 | Importing |
MSGV1 | Call by reference | Type reference (TYPE) | C | SY-MSGV1 | 20010522 | ||
| 6 | Importing |
MSGV2 | Call by reference | Type reference (TYPE) | C | SY-MSGV2 | 20010522 | ||
| 7 | Importing |
MSGV3 | Call by reference | Type reference (TYPE) | C | SY-MSGV3 | 20010522 | ||
| 8 | Importing |
MSGV4 | Call by reference | Type reference (TYPE) | C | SY-MSGV4 | 20010522 |
Method _SET_SY_MESSAGE on class CL_SWF_API_BASE_HANDLER has no exception.
Method _SET_WAPI_MESSAGES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
MESSAGE_LINES | Call by reference | Type reference (TYPE) | SAPI_MSG_LINES | Tabelle mit sap-wapi-Message (Zeilen) | 20010522 | ||
| 2 | Importing |
MESSAGE_STRUCT | Call by reference | Type reference (TYPE) | SAPI_MSG_STRUC | Tabelle mit sap-wapi-Message (Strukturen) | 20010522 |
Method _SET_WAPI_MESSAGES on class CL_SWF_API_BASE_HANDLER has no exception.
History
| Last changed by/on | SAP | 20110908 |
| SAP Release Created in | 620 |
