SAP ABAP Class /SCMB/CL_DF_DOCFLOW2 (Document Flow API)
Hierarchy
☛
PI_BASIS (Software Component) Basis Plug-In
⤷
SCM-BAS-DF (Application Component) Cross-System and Cross-Partner Document Flow
⤷
/SCMB/FLOW_NET (Package) Document Flow, Link
PI_BASIS (Software Component) Basis Plug-In⤷
SCM-BAS-DF (Application Component) Cross-System and Cross-Partner Document Flow⤷
/SCMB/FLOW_NET (Package) Document Flow, LinkProperties
| Class | /SCMB/CL_DF_DOCFLOW2 | |
| Short Description | Document Flow API | |
| Super Class | ||
| Instantiability of a Class | 0 | Private |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | /SCMB/FLOW_NET | Document Flow, Link |
| Created | 20090325 | SAP |
| Last change | 20110908 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
Class /SCMB/CL_DF_DOCFLOW2 has no forward declaration.
Interfaces
Class /SCMB/CL_DF_DOCFLOW2 has no interface implemented.
Friends
Class /SCMB/CL_DF_DOCFLOW2 has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | GC_DELETE_OPTION |
Constant | Public | See coding | Network Deletion Options | 20090629 | |||
| 2 | GV_TRANSFORMATION |
Static Attribute | Public | Type reference (TYPE) | CXSLTDESC | 'ID' | Name of an XSLT Program | 20090629 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | DELETE_NETWORK |
Static method | Public | Method | Delete Document Network | 20090629 |
| 2 | GET_NETWORK_BY_DOCOBJ |
Static method | Private | Method | Get Network of Document Objects | 20090629 |
| 3 | LOG_CALLSTACK |
Static method | Private | Method | collect WTnum, callstack and log into saab | 20130624 |
| 4 | READ_NETWORK |
Static method | Public | Method | Read Document Network | 20090629 |
| 5 | REFRESH |
Static method | Public | Method | Refresh Internal Buffers | 20090629 |
| 6 | REFRESH_LOG |
Static method | Private | Method | 20130624 | |
| 7 | SEARCH_NETWORK |
Static method | Public | Method | Search Document Network | 20090629 |
| 8 | SET_TRANSFORMATION |
Static method | Public | Method | Setting the XSLT Program To Be Used | 20090629 |
| 9 | WRITE_NETWORK |
Static method | Public | Method | Write Document Network | 20090629 |
Events
Class /SCMB/CL_DF_DOCFLOW2 has no event.
Types
Class /SCMB/CL_DF_DOCFLOW2 has no local type.
Method Signatures
Method DELETE_NETWORK Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
ET_RELATION_DELETED | Call by reference | Type reference (TYPE) | /SCMB/DF_RELIDX_TBL | Document Flow: Index of Link | 20090629 | ||
| 2 | Exporting |
ET_RELATION_NOT_DELETED | Call by reference | Type reference (TYPE) | /SCMB/DF_RELIDX_TBL | Document Flow: Index of Link | 20090629 | ||
| 3 |  Importing |
IT_DOCUMENT | Call by reference | Type reference (TYPE) | /SCMB/DF_DOCUMENT_TBL | Document Flow: Document | 20090629 | ||
| 4 | Importing |
IT_DOCUMENTX | Call by reference | Type reference (TYPE) | /SCMB/DF_DOCUMENTX_TBL | Document Flow: Document (xstring) | 20130211 | ||
| 5 | Importing |
IT_RELATION | Call by reference | Type reference (TYPE) | /SCMB/DF_RELATION_TBL | Document Flow: Link | 20090629 | ||
| 6 | Importing |
IV_DELETE_OPTION | Call by reference | Type reference (TYPE) | /SCMB/DF_DELETE_OPTION | /SCMB/CL_DF_DOCFLOW2=>GC_DELETE_OPTION-LINK | Document Network Deletion Option | 20090629 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  /SCMB/CX_DF_ATTRIBUTE |
20090629 | ||
| 2 | /SCMB/CX_DF_DOCUMENT |
20090629 | ||
| 3 | /SCMB/CX_DF_RELATION |
20090629 |
Method GET_NETWORK_BY_DOCOBJ Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_ATTRIBUTE | Call by reference | Type reference (TYPE) | /SCMB/DF_ATTRIBUTE_TBL | Document Flow: Additional Data | 20090629 | ||
| 2 | Exporting |
ET_ATTRIBUTEX | Call by reference | Type reference (TYPE) | /SCMB/DF_ATTRIBUTEX_TBL | Document Flow: Additional Data (xstring) | 20130211 | ||
| 3 | Exporting |
ET_DOCUMENT | Call by reference | Type reference (TYPE) | /SCMB/DF_DOCUMENT_TBL | Document Flow: Document | 20090629 | ||
| 4 | Exporting |
ET_DOCUMENTX | Call by reference | Type reference (TYPE) | /SCMB/DF_DOCUMENTX_TBL | Document Flow: Document (xstring) | 20130211 | ||
| 5 | Exporting |
ET_INCONSISTENT | Call by reference | Type reference (TYPE) | /SCMB/DF_DOCUMENT_TBL | Document Flow: Document | 20090629 | ||
| 6 | Exporting |
ET_INCONSISTENTX | Call by reference | Type reference (TYPE) | /SCMB/DF_DOCUMENTX_TBL | Document Flow: Document (xstring) | 20130211 | ||
| 7 | Exporting |
ET_RELATION | Call by reference | Type reference (TYPE) | /SCMB/DF_RELATION_TBL | Document Flow: Link | 20090629 | ||
| 8 | Exporting |
ET_RELATION_PARTIAL | Call by reference | Type reference (TYPE) | /SCMB/DF_RELATION_PARTIAL_TBL | Document Flow: Link, By Document | 20090629 | ||
| 9 | Importing |
IS_NOT_REQUESTED | Call by reference | Type reference (TYPE) | /SCMB/DF_REQUEST_GET_LINK | Document Flow: Parameters Not Requested | 20090629 | ||
| 10 | Importing |
IT_DOC_OBJ_IDX | Call by reference | Type reference (TYPE) | /SCMB/CL_DF_CORE=>TYP_T_DOC_OBJ_IDX | Document Object by Index Table | 20090629 | ||
| 11 | Importing |
IT_RELATION_TYPE | Call by reference | Type reference (TYPE) | /SCMB/DF_RELATION_TYPE_TBL | Document Flow: Link Category | 20090629 | ||
| 12 | Importing |
IV_COMPLETENESS | Call by reference | Type reference (TYPE) | /SCMB/DF_COMPLETENESS | Document Flow: Completeness | 20090629 | ||
| 13 | Importing |
IV_HANDLE_INCONSISTENCY | Call by reference | Type reference (TYPE) | /SCMB/DF_ERROR | DocFlow error code | 20090629 | ||
| 14 | Importing |
IV_MAXIMAL_CHAIN | Call by reference | Type reference (TYPE) | /SCMB/DF_NET_CHAIN | Document Flow: Maximum Chain | 20090629 | ||
| 15 | Importing |
IV_RELATION_BACKWARD | Call by reference | Type reference (TYPE) | /SCMB/DF_RELATION_CNT | Document Flow: Number of Links | 20090629 | ||
| 16 | Importing |
IV_RELATION_FORWARD | Call by reference | Type reference (TYPE) | /SCMB/DF_RELATION_CNT | Document Flow: Number of Links | 20090629 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | /SCMB/CX_DF_ATTRIBUTE |
20090629 | ||
| 2 | /SCMB/CX_DF_DOCUMENT |
20090629 | ||
| 3 | /SCMB/CX_DF_RELATION |
20090629 |
Method LOG_CALLSTACK Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IO_DFO | Call by reference | Object reference (TYPE REF TO) | /SCMB/CL_DF_DOC | Document Flow: Document Identification | 20130624 | ||
| 2 |  Returning |
RV_CONTINUE | Value transfer | Type reference (TYPE) | STRING | 20130624 |
Method LOG_CALLSTACK on class /SCMB/CL_DF_DOCFLOW2 has no exception.
Method READ_NETWORK Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_ATTRIBUTE | Call by reference | Type reference (TYPE) | /SCMB/DF_ATTRIBUTE_TBL | Document Flow: Additional Data | 20090629 | ||
| 2 | Exporting |
ET_ATTRIBUTEX | Call by reference | Type reference (TYPE) | /SCMB/DF_ATTRIBUTEX_TBL | Document Flow: Additional Data (xstring) | 20130211 | ||
| 3 | Exporting |
ET_DOCUMENT | Call by reference | Type reference (TYPE) | /SCMB/DF_DOCUMENT_TBL | Document Flow: Document | 20090629 | ||
| 4 | Exporting |
ET_DOCUMENTX | Call by reference | Type reference (TYPE) | /SCMB/DF_DOCUMENTX_TBL | Document Flow: Document (xstring) | 20130211 | ||
| 5 | Exporting |
ET_INCONSISTENT | Call by reference | Type reference (TYPE) | /SCMB/DF_DOCUMENT_TBL | Document Flow: Document | 20090629 | ||
| 6 | Exporting |
ET_INCONSISTENTX | Call by reference | Type reference (TYPE) | /SCMB/DF_DOCUMENTX_TBL | Document Flow: Document (xstring) | 20130211 | ||
| 7 | Exporting |
ET_RELATION | Call by reference | Type reference (TYPE) | /SCMB/DF_RELATION_TBL | Document Flow: Link | 20090629 | ||
| 8 | Exporting |
ET_RELATION_PARTIAL | Call by reference | Type reference (TYPE) | /SCMB/DF_RELATION_PARTIAL_TBL | Document Flow: Link, By Document | 20090629 | ||
| 9 | Importing |
IS_NOT_REQUESTED | Call by reference | Type reference (TYPE) | /SCMB/DF_REQUEST_GET_LINK | Document Flow: Parameters Not Requested | 20090629 | ||
| 10 | Importing |
IT_DOCUMENT | Call by reference | Type reference (TYPE) | /SCMB/DF_DOCUMENT_TBL | Document Flow: Document | 20090629 | ||
| 11 | Importing |
IT_DOCUMENTX | Call by reference | Type reference (TYPE) | /SCMB/DF_DOCUMENTX_TBL | Document Flow: Document (xstring) | 20130211 | ||
| 12 | Importing |
IT_RELATION_TYPE | Call by reference | Type reference (TYPE) | /SCMB/DF_RELATION_TYPE_TBL | Document Flow: Link Category | 20090629 | ||
| 13 | Importing |
IV_COMPLETENESS | Call by reference | Type reference (TYPE) | /SCMB/DF_COMPLETENESS | /SCMB/CL_DF_RELATION_TYPE=>GC_COMPLETE | Document Flow: Completeness | 20090629 | |
| 14 | Importing |
IV_HANDLE_INCONSISTENCY | Call by reference | Type reference (TYPE) | /SCMB/DF_ERROR | /SCMB/CL_DF_DOCFLOW=>GC_RAISE_EXCEPTION | DocFlow error code | 20090629 | |
| 15 | Importing |
IV_MAXIMAL_CHAIN | Call by reference | Type reference (TYPE) | /SCMB/DF_NET_CHAIN | Document Flow: Maximum Chain | 20090629 | ||
| 16 | Importing |
IV_RELATION_BACKWARD | Call by reference | Type reference (TYPE) | /SCMB/DF_RELATION_CNT | 10 | Document Flow: Number of Links | 20090629 | |
| 17 | Importing |
IV_RELATION_FORWARD | Call by reference | Type reference (TYPE) | /SCMB/DF_RELATION_CNT | 10 | Document Flow: Number of Links | 20090629 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | /SCMB/CX_DF_ATTRIBUTE |
20090629 | ||
| 2 | /SCMB/CX_DF_DOCUMENT |
20090629 | ||
| 3 | /SCMB/CX_DF_RELATION |
20090629 |
Method REFRESH Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_INVALIDATE | Call by reference | Type reference (TYPE) | FLAG | 'X' | 20090629 |
Method REFRESH on class /SCMB/CL_DF_DOCFLOW2 has no exception.
Method REFRESH_LOG Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RV_CONTINUE | Value transfer | Type reference (TYPE) | STRING | 20130624 |
Method REFRESH_LOG on class /SCMB/CL_DF_DOCFLOW2 has no exception.
Method SEARCH_NETWORK Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_ATTRIBUTE | Call by reference | Type reference (TYPE) | /SCMB/DF_ATTRIBUTE_TBL | Document Flow: Additional Data | 20090629 | ||
| 2 | Exporting |
ET_ATTRIBUTEX | Call by reference | Type reference (TYPE) | /SCMB/DF_ATTRIBUTEX_TBL | Document Flow: Additional Data (xstring) | 20130211 | ||
| 3 | Exporting |
ET_DOCUMENT | Call by reference | Type reference (TYPE) | /SCMB/DF_DOCUMENT_TBL | Document Flow: Document | 20090629 | ||
| 4 | Exporting |
ET_DOCUMENTX | Call by reference | Type reference (TYPE) | /SCMB/DF_DOCUMENTX_TBL | Document Flow: Document (xstring) | 20130211 | ||
| 5 | Exporting |
ET_INCONSISTENT | Call by reference | Type reference (TYPE) | /SCMB/DF_DOCUMENT_TBL | Document Flow: Document | 20090629 | ||
| 6 | Exporting |
ET_INCONSISTENTX | Call by reference | Type reference (TYPE) | /SCMB/DF_DOCUMENTX_TBL | Document Flow: Document (xstring) | 20130211 | ||
| 7 | Exporting |
ET_RELATION | Call by reference | Type reference (TYPE) | /SCMB/DF_RELATION_TBL | Document Flow: Link | 20090629 | ||
| 8 | Exporting |
ET_RELATION_PARTIAL | Call by reference | Type reference (TYPE) | /SCMB/DF_RELATION_PARTIAL_TBL | Document Flow: Link, By Document | 20090629 | ||
| 9 | Importing |
IS_NOT_REQUESTED | Call by reference | Type reference (TYPE) | /SCMB/DF_REQUEST_GET_LINK | Document Flow: Parameters Not Requested | 20090629 | ||
| 10 | Importing |
IT_DOCUMENT_CRITERIA | Call by reference | Type reference (TYPE) | /SCMB/DF_DOCUMENT_CRITERIA_TBL | Document Flow: Criteria for Document Selection | 20090629 | ||
| 11 | Importing |
IT_RELATION_TYPE | Call by reference | Type reference (TYPE) | /SCMB/DF_RELATION_TYPE_TBL | Document Flow: Link Category | 20090629 | ||
| 12 | Importing |
IV_CATEGORY | Call by reference | Type reference (TYPE) | /SCMB/DF_CATEGORY | Document Flow: Document Category | 20090629 | ||
| 13 | Importing |
IV_COMPLETENESS | Call by reference | Type reference (TYPE) | /SCMB/DF_COMPLETENESS | /SCMB/CL_DF_RELATION_TYPE=>GC_COMPLETE | Document Flow: Completeness | 20090629 | |
| 14 | Importing |
IV_HANDLE_INCONSISTENCY | Call by reference | Type reference (TYPE) | /SCMB/DF_ERROR | /SCMB/CL_DF_DOCFLOW=>GC_RAISE_EXCEPTION | DocFlow error code | 20090629 | |
| 15 | Importing |
IV_MAXIMAL_CHAIN | Call by reference | Type reference (TYPE) | /SCMB/DF_NET_CHAIN | Document Flow: Maximum Chain | 20090629 | ||
| 16 | Importing |
IV_RELATION_BACKWARD | Call by reference | Type reference (TYPE) | /SCMB/DF_RELATION_CNT | 10 | Document Flow: Number of Links | 20090629 | |
| 17 | Importing |
IV_RELATION_FORWARD | Call by reference | Type reference (TYPE) | /SCMB/DF_RELATION_CNT | 10 | Document Flow: Number of Links | 20090629 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | /SCMB/CX_DF_ATTRIBUTE |
20090629 | ||
| 2 | /SCMB/CX_DF_DOCUMENT |
20090629 | ||
| 3 | /SCMB/CX_DF_RELATION |
20090629 |
Method SET_TRANSFORMATION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_TRANSFORMATION | Call by reference | Type reference (TYPE) | CXSLTDESC | 'ID' | Name of an XSLT Program | 20090629 |
Method SET_TRANSFORMATION on class /SCMB/CL_DF_DOCFLOW2 has no exception.
Method WRITE_NETWORK Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IT_ATTRIBUTE | Call by reference | Type reference (TYPE) | /SCMB/DF_ATTRIBUTE_TBL | Document Flow: Additional Data | 20090629 | ||
| 2 | Importing |
IT_ATTRIBUTEX | Call by reference | Type reference (TYPE) | /SCMB/DF_ATTRIBUTEX_TBL | Document Flow: Additional Data (xstring) | 20130211 | ||
| 3 | Importing |
IT_DOCUMENT | Call by reference | Type reference (TYPE) | /SCMB/DF_DOCUMENT_TBL | Document Flow: Document | 20090629 | ||
| 4 | Importing |
IT_DOCUMENTX | Call by reference | Type reference (TYPE) | /SCMB/DF_DOCUMENTX_TBL | Document Flow: Document (xstring) | 20130211 | ||
| 5 | Importing |
IT_RELATION | Call by reference | Type reference (TYPE) | /SCMB/DF_RELATION_TBL | Document Flow: Link | 20090629 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | /SCMB/CX_DF_ATTRIBUTE |
20090629 | ||
| 2 | /SCMB/CX_DF_DOCUMENT |
20090629 | ||
| 3 | /SCMB/CX_DF_RELATION |
20090629 |
History
| Last changed by/on | SAP | 20110908 |
| SAP Release Created in |
