SAP ABAP Class /SCMB/CL_DF_DOCUMENT2 (Document)
Hierarchy
☛
PI_BASIS (Software Component) Basis Plug-In
⤷
SCM-BAS-DF (Application Component) Cross-System and Cross-Partner Document Flow
⤷
/SCMB/FLOW_DOCUMENT (Package) Document Flow, Document Administration
⤷
⤷
Properties
| Class | /SCMB/CL_DF_DOCUMENT2 | |
| Short Description | Document | |
| Super Class | ||
| Instantiability of a Class | 0 | Private |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | /SCMB/FLOW_DOCUMENT | Document Flow, Document Administration |
| Created | 20090629 | SAP |
| Last change | 20110908 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
Class /SCMB/CL_DF_DOCUMENT2 has no forward declaration.
Interfaces
Class /SCMB/CL_DF_DOCUMENT2 has no interface implemented.
Friends
| # | Friend | Modeled only | Created on | Description |
|---|---|---|---|---|
| 1 | /SCMB/CL_DF_CORE | 20090629 | Document Flow Core Functions | |
| 2 | /SCMB/CL_DF_DOCUMENT | 20090629 | Document Flow: Document Administration |
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Instance attribute | Private | Object reference (TYPE REF TO) | /SCMB/CL_DF_DOC | Document Persistent Class | 20090629 | |||
| 2 | Instance attribute | Public | Type reference (TYPE) | /SCMB/S_DF_DOC_KEY | Document Key Structure | 20090629 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Public | Constructor | CONSTRUCTOR | 20090629 | |
| 2 | Static method | Public | Method | Create Document | 20090629 | |
| 3 | Instance method | Public | Method | Delete Document | 20090629 | |
| 4 | Instance method | Public | Method | Get Document Attributes | 20090629 | |
| 5 | Instance method | Public | Method | Get Links of Document (forward/backward) | 20090629 | |
| 6 | Static method | Public | Method | Read Document | 20090629 | |
| 7 | Instance method | Public | Method | Set Document Attributes | 20090629 |
Events
Class /SCMB/CL_DF_DOCUMENT2 has no event.
Types
Class /SCMB/CL_DF_DOCUMENT2 has no local type.
Method Signatures
Method CONSTRUCTOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IO_DOC | Call by reference | Object reference (TYPE REF TO) | /SCMB/CL_DF_DOC | 20090629 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20090629 |
Method CREATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_BOR_ID | Call by reference | Type reference (TYPE) | SIBFBORIID | 20090629 | ||||
| 2 | IV_BOR_TYPE | Call by reference | Type reference (TYPE) | SIBFTYPEID | 20090629 | ||||
| 3 | IV_BSKEY | Call by reference | Type reference (TYPE) | SLD_BSKEY | 20090629 | ||||
| 4 | IV_CATEGORY | Call by reference | Type reference (TYPE) | /SCMB/DF_CATEGORY | 20090629 | ||||
| 5 | IV_CHARACTERISTIC | Call by reference | Type reference (TYPE) | STRING | 20090629 | ||||
| 6 | IV_CHARACTERISTICX | Call by reference | Type reference (TYPE) | XSTRING | 20130211 | ||||
| 7 | IV_GUID_APP | Call by reference | Type reference (TYPE) | /SCMB/DF_GUID | 20090629 | ||||
| 8 | IV_LOGSYS | Call by reference | Type reference (TYPE) | LOGSYS | 20090629 | ||||
| 9 | RO_DOC_OBJ | Value transfer | Object reference (TYPE REF TO) | /SCMB/CL_DF_DOCUMENT2 | 20090629 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20090629 |
Method DELETE Signature
Method DELETE on class /SCMB/CL_DF_DOCUMENT2 has no parameter.
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20090629 |
Method GET_ATTRIBUTES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | EV_BOR_ID | Call by reference | Type reference (TYPE) | SIBFBORIID | 20090629 | ||||
| 2 | EV_BOR_TYPE | Call by reference | Type reference (TYPE) | SIBFTYPEID | 20090629 | ||||
| 3 | EV_BSKEY | Call by reference | Type reference (TYPE) | SLD_BSKEY | 20090629 | ||||
| 4 | EV_CHARACTERISTIC | Call by reference | Type reference (TYPE) | STRING | 20090629 | ||||
| 5 | EV_CHARACTERISTICX | Call by reference | Type reference (TYPE) | XSTRING | 20130211 | ||||
| 6 | EV_GUID_APP | Call by reference | Type reference (TYPE) | /SCMB/DF_GUID | 20090629 | ||||
| 7 | EV_LOGSYS | Call by reference | Type reference (TYPE) | LOGSYS | 20090629 |
Method GET_ATTRIBUTES on class /SCMB/CL_DF_DOCUMENT2 has no exception.
Method GET_LINKS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_LINK_BKWRD | Call by reference | Type reference (TYPE) | /SCMB/T_DF_LINK_OBJ | 20090629 | ||||
| 2 | ET_LINK_FRWRD | Call by reference | Type reference (TYPE) | /SCMB/T_DF_LINK_OBJ | 20090629 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20090629 |
Method READ Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_CATEGORY | Call by reference | Type reference (TYPE) | /SCMB/DF_CATEGORY | 20090629 | ||||
| 2 | IV_CHARACTERISTIC | Call by reference | Type reference (TYPE) | STRING | 20090629 | ||||
| 3 | IV_CHARACTERISTICX | Call by reference | Type reference (TYPE) | XSTRING | 20130211 | ||||
| 4 | IV_GUID_APP | Call by reference | Type reference (TYPE) | /SCMB/DF_GUID | 20090629 | ||||
| 5 | RO_DOC_OBJ | Value transfer | Object reference (TYPE REF TO) | /SCMB/CL_DF_DOCUMENT2 | 20090629 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 20090629 | |||
| 2 | 20090629 |
Method SET_ATTRIBUTES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_BOR_ID | Call by reference | Type reference (TYPE) | SIBFBORIID | 20090629 | ||||
| 2 | IV_BOR_TYPE | Call by reference | Type reference (TYPE) | SIBFTYPEID | 20090629 | ||||
| 3 | IV_BSKEY | Call by reference | Type reference (TYPE) | SLD_BSKEY | 20090629 | ||||
| 4 | IV_CHARACTERISTIC | Call by reference | Type reference (TYPE) | STRING | 20090629 | ||||
| 5 | IV_CHARACTERISTICX | Call by reference | Type reference (TYPE) | XSTRING | 20130211 | ||||
| 6 | IV_GUID_APP | Call by reference | Type reference (TYPE) | /SCMB/DF_GUID | 20090629 | ||||
| 7 | IV_LOGSYS | Call by reference | Type reference (TYPE) | LOGSYS | 20090629 |
Method SET_ATTRIBUTES on class /SCMB/CL_DF_DOCUMENT2 has no exception.
History
| Last changed by/on | SAP | 20110908 |
| SAP Release Created in |