SAP ABAP Class /SCMB/CL_DF_DOCUMENT (Document Flow: Document Administration)
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
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 AdministrationProperties
| Class | /SCMB/CL_DF_DOCUMENT | |
| Short Description | Document Flow: Document Administration | |
| 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 | 20020814 | SAP |
| Last change | 20110908 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 |  ABAP |
Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
Class /SCMB/CL_DF_DOCUMENT has no interface implemented.
Friends
| # | Friend | Modeled only | Created on | Description |
|---|---|---|---|---|
| 1 | /SCMB/CL_DF_DOC | 20031007 | Document Flow: Document Identification | |
| 2 | /SCMB/CL_DF_DOCFLOW | 20031007 | Document Flow |
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | GC_FLD_CLIENT |
Constant | Public | Type reference (TYPE) | FIELDNAME | 'CLIENT' | Field Name | 20030109 | |
| 2 | GC_FLD_DOCUMENT |
Constant | Public | Type reference (TYPE) | FIELDNAME | 'DOCUMENT' | Field Name | 20030109 | |
| 3 | GC_FLD_GUID |
Constant | Public | Type reference (TYPE) | FIELDNAME | 'GUID' | Field Name | 20030109 | |
| 4 | GC_FLD_ITEM |
Constant | Public | Type reference (TYPE) | FIELDNAME | 'ITEM' | Field Name | 20030109 | |
| 5 | GC_FLD_PARTNER |
Constant | Public | Type reference (TYPE) | FIELDNAME | 'DOC_PARTNER_NO' | Field Name | 20060818 | |
| 6 | GC_OSTATUS_NEW |
Constant | Public | Type reference (TYPE) | OS_OSTATUS | 1 | Persistent Object Created New | 20040825 | |
| 7 | GV_NEXT_DOCIDX |
Static Attribute | Private | Type reference (TYPE) | /SCMB/DF_DOCIDX | Document Flow: Index of Document | 20051019 | ||
| 8 | MO_DOC |
Instance attribute | Public | Object reference (TYPE REF TO) | /SCMB/CL_DF_DOC | Document Flow: Document Identification | 20030116 | ||
| 9 | MS_DOC |
Instance attribute | Public | Type reference (TYPE) | SIBFLPORB | Local Persistent Object Reference - BOR Compatible | 20020902 | ||
| 10 | MV_BSKEY |
Instance attribute | Public | Type reference (TYPE) | SLD_BSKEY | Key Name of a Business System | 20031007 | ||
| 11 | MV_DOCIDX |
Instance attribute | Public | Type reference (TYPE) | /SCMB/DF_DOCIDX | Document Flow: Index of Document | 20021017 | ||
| 12 | MV_LOGSYS |
Instance attribute | Public | Type reference (TYPE) | LOGSYS | Logical System | 20020902 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | CLASS_CONSTRUCTOR |
Static method | Public | Constructor | CLASS_CONSTRUCTOR | 20040219 |
| 2 | CONVERT_CHARACTERISTIC |
Static method | Public | Method | Convert Attributes from Characteristics to ABAP Values | 20060830 |
| 3 | CREATE |
Static method | Public | Method | Create Document | 20020814 |
| 4 | DELETE |
Instance method | Public | Method | Delete Document | 20020823 |
| 5 | GET |
Static method | Public | Method | Read Document | 20020819 |
| 6 | GET_BY_CHARACTERISTIC |
Static method | Private | Method | Obsolete | 20060830 |
| 7 | GET_NEXT_DOCIDX |
Static method | Public | Method | Obsolete | 20051018 |
| 8 | GET_STATUS |
Instance method | Public | Method | Provides Status of Persistent Object | 20040825 |
| 9 | GET_TRANSLATION |
Static method | Public | Method | Create XML Translation Statement | 20031016 |
| 10 | INIT_DOCIDX |
Static method | Public | Method | Obsolete | 20051018 |
| 11 | MODIFY_CHARACTERISTIC |
Static method | Public | Method | Change Document Attributes | 20040528 |
| 12 | REFRESH_NEG_BUFFER |
Static method | Public | Method | Obsolete | 20050518 |
| 13 | REFRESH_REF_BUFFER |
Static method | Public | Event handling method | Obsolete | 20031119 |
| 14 | RENAME_DOCUMENT |
Static method | Public | Method | Change Readable Document Number | 20031010 |
| 15 | SEARCH |
Static method | Public | Method | Searches for Documents | 20021022 |
| 16 | SET_ATTRIBUTES |
Static method | Public | Method | Set Class Attributes | 20021018 |
| 17 | SET_DOCIDX |
Instance method | Private | Method | Set Index of Document | 20090212 |
Events
Class /SCMB/CL_DF_DOCUMENT has no event.
Types
Class /SCMB/CL_DF_DOCUMENT has no local type.
Method Signatures
Method CLASS_CONSTRUCTOR Signature
Method CLASS_CONSTRUCTOR on class /SCMB/CL_DF_DOCUMENT has no parameter.
Method CLASS_CONSTRUCTOR on class /SCMB/CL_DF_DOCUMENT has no exception.
Method CONVERT_CHARACTERISTIC Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
ET_CHAR_FIELDS | Call by reference | Type reference (TYPE) | /SCMB/DF_CHARFIELD_TBL | Characteristics field catalogue | 20060830 | ||
| 2 |  Importing |
IS_DOCUMENT | Call by reference | Type reference (TYPE) | /SCMB/DF_DOCUMENT | DF document node data | 20060830 | ||
| 3 | Importing |
IS_DOCUMENTX | Call by reference | Type reference (TYPE) | /SCMB/DF_DOCUMENTX | Belegfluss: Belegidentifikation | 20130211 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  /SCMB/CX_DFI_DOCUMENT_SETUP |
Belegfluss: Fehler in der Belegverwaltung | 20060830 | |
| 2 | /SCMB/CX_DF_DOCUMENT |
Belegfluss: Belegfehler | 20060830 |
Method CREATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
EO_DOCUMENT | Call by reference | Object reference (TYPE REF TO) | /SCMB/CL_DF_DOCUMENT | Belegfluss: Belegverwaltung | 20030121 | ||
| 2 | Exporting |
ET_DOCUMENT | Call by reference | Type reference (TYPE) | /SCMB/DF_DOCIDX_TBL | Belegfluss: Belegreferenz | 20051017 | ||
| 3 | Exporting |
EV_DOCUMENT_ID | Call by reference | Type reference (TYPE) | /SCMB/DF_DOC_ID | Belegfluss: Beleg-ID (GUID) | 20020814 | ||
| 4 | Exporting |
EV_DOCUMENT_TYPE | Call by reference | Type reference (TYPE) | /SCMB/DF_CATEGORY | Belegfluss: Belegtyp | 20020814 | ||
| 5 | Importing |
IS_DOC | Call by reference | Type reference (TYPE) | SIBFLPORB | Lokale Persistente Objektreferenz - BOR kompatibel | 20030109 | ||
| 6 | Importing |
IS_DOCUMENT | Call by reference | Type reference (TYPE) | /SCMB/DF_DOCUMENT | Belegfluss: Belegidentifikation | 20020814 | ||
| 7 | Importing |
IS_DOCUMENTX | Call by reference | Type reference (TYPE) | /SCMB/DF_DOCUMENTX | Belegfluss: Belegidentifikation | 20130211 | ||
| 8 | Importing |
IT_DOCUMENT | Call by reference | Type reference (TYPE) | /SCMB/DF_DOCUMENT_TBL | Belegfluss: Beleg | 20051014 | ||
| 9 | Importing |
IT_DOCUMENTX | Call by reference | Type reference (TYPE) | /SCMB/DF_DOCUMENTX_TBL | Belegfluss: Beleg | 20130211 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | /SCMB/CX_DFI_DOCUMENT |
Belegfluss: Belegfehler (Detail) | 20020829 | |
| 2 | /SCMB/CX_DF_DOCUMENT |
Belegfluss: Belegfehler | 20060830 |
Method DELETE Signature
Method DELETE on class /SCMB/CL_DF_DOCUMENT has no parameter.
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | /SCMB/CX_DFI_DOCUMENT |
Belegfluss: Belegfehler (Detail) | 20020829 |
Method GET Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
EO_DOC | Call by reference | Object reference (TYPE REF TO) | /SCMB/CL_DF_DOC | Belegfluss: Belegidentifikation | 20030122 | ||
| 2 | Exporting |
EO_DOCUMENT | Call by reference | Object reference (TYPE REF TO) | /SCMB/CL_DF_DOCUMENT | Belegfluss: Belegverwaltung | 20030121 | ||
| 3 | Exporting |
ET_DOCUMENT | Call by reference | Type reference (TYPE) | /SCMB/DF_DOC_TBL | Belegfluss: Belegreferenzen | 20041020 | ||
| 4 | Exporting |
EV_DOCUMENT_ID | Call by reference | Type reference (TYPE) | /SCMB/DF_DOC_ID | Belegfluss: Beleg-ID (GUID) | 20020819 | ||
| 5 | Exporting |
EV_DOCUMENT_TYPE | Call by reference | Type reference (TYPE) | /SCMB/DF_CATEGORY | Belegfluss: Belegtyp | 20020819 | ||
| 6 | Importing |
IS_DOC | Call by reference | Type reference (TYPE) | SIBFLPORB | Lokale Persistente Objektreferenz - BOR kompatibel | 20020902 | ||
| 7 | Importing |
IS_DOCUMENT | Call by reference | Type reference (TYPE) | /SCMB/DF_DOCUMENT | Belegfluss: Belegidentifikation | 20020819 | ||
| 8 | Importing |
IS_DOCUMENTX | Call by reference | Type reference (TYPE) | /SCMB/DF_DOCUMENTX | Belegfluss: Belegidentifikation | 20130211 | ||
| 9 | Importing |
IT_DOC | Call by reference | Type reference (TYPE) | SIBFLPORBT | Tabelle von Lokalen Pers. Objektreferenzen - BOR kompatibel | 20051012 | ||
| 10 | Importing |
IT_DOCUMENT | Call by reference | Type reference (TYPE) | /SCMB/DF_DOCUMENT_TBL | Belegfluss: Beleg | 20041020 | ||
| 11 | Importing |
IT_DOCUMENTX | Call by reference | Type reference (TYPE) | /SCMB/DF_DOCUMENTX_TBL | Belegfluss: Beleg | 20130211 | ||
| 12 | Importing |
IV_DATA_NOT_REQUESTED | Call by reference | Type reference (TYPE) | /SCMB/DF_DATA_NOT_REQUESTED | Belegfluss: Belegbeschreibung nicht angefordert | 20021022 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | /SCMB/CX_DFI_DOCUMENT |
Belegfluss: Belegfehler (Detail) | 20020829 | |
| 2 | /SCMB/CX_DF_DOCUMENT |
Belegfluss: Belegfehler | 20060920 |
Method GET_BY_CHARACTERISTIC Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
EO_DOCUMENT | Call by reference | Object reference (TYPE REF TO) | /SCMB/CL_DF_DOCUMENT | Found DF document object | 20060830 | ||
| 2 | Importing |
IS_DOCUMENT | Call by reference | Type reference (TYPE) | /SCMB/DF_DOCUMENT | DF document node data | 20060830 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | /SCMB/CX_DFI_DOCUMENT |
Belegfluss: Belegfehler (Detail) | 20060830 | |
| 2 | /SCMB/CX_DFI_DOCUMENT_SETUP |
Belegfluss: Fehler in der Belegverwaltung | 20060830 | |
| 3 | /SCMB/CX_DF_DOCUMENT |
Belegfluss: Belegfehler | 20060830 |
Method GET_NEXT_DOCIDX Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Returning |
EV_DOCIDX | Value transfer | Type reference (TYPE) | /SCMB/DF_DOCIDX | Belegfluss: Index Beleg | 20051018 |
Method GET_NEXT_DOCIDX on class /SCMB/CL_DF_DOCUMENT has no exception.
Method GET_STATUS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
EV_OSTATUS | Value transfer | Type reference (TYPE) | OS_OSTATUS | Status eines Objekts (verwaltetes Objekt) | 20040825 |
Method GET_STATUS on class /SCMB/CL_DF_DOCUMENT has no exception.
Method GET_TRANSLATION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Changing |
CS_CHARACTERISTIC | Call by reference | Type reference (TYPE) | ANY | 20031016 | |||
| 2 | Exporting |
ET_CONVERSION | Call by reference | Type reference (TYPE) | ABAP_TRANS_RESBIND_TAB | 20031016 | |||
| 3 | Importing |
IV_TABNAME | Call by reference | Type reference (TYPE) | TABNAME | Tabellenname | 20031016 |
Method GET_TRANSLATION on class /SCMB/CL_DF_DOCUMENT has no exception.
Method INIT_DOCIDX Signature
Method INIT_DOCIDX on class /SCMB/CL_DF_DOCUMENT has no parameter.
Method INIT_DOCIDX on class /SCMB/CL_DF_DOCUMENT has no exception.
Method MODIFY_CHARACTERISTIC Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
EO_DOCUMENT | Call by reference | Object reference (TYPE REF TO) | /SCMB/CL_DF_DOCUMENT | Belegfluss: Belegverwaltung | 20040528 | ||
| 2 | Exporting |
EV_DOCUMENT_ID | Call by reference | Type reference (TYPE) | /SCMB/DF_DOC_ID | Belegfluss: Beleg-ID (GUID) | 20040528 | ||
| 3 | Exporting |
EV_DOCUMENT_TYPE | Call by reference | Type reference (TYPE) | /SCMB/DF_CATEGORY | Belegfluss: Belegtyp | 20040528 | ||
| 4 | Importing |
IS_DOCUMENT | Call by reference | Type reference (TYPE) | /SCMB/DF_DOCUMENT | Belegfluss: Belegidentifikation | 20040528 | ||
| 5 | Importing |
IS_DOCUMENTX | Call by reference | Type reference (TYPE) | /SCMB/DF_DOCUMENTX | Belegfluss: Belegidentifikation | 20130211 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | /SCMB/CX_DFI_DOCUMENT |
Belegfluss: Belegfehler (Detail) | 20040528 | |
| 2 | /SCMB/CX_DF_DOCUMENT |
Belegfluss: Belegfehler | 20060920 |
Method REFRESH_NEG_BUFFER Signature
Method REFRESH_NEG_BUFFER on class /SCMB/CL_DF_DOCUMENT has no parameter.
Method REFRESH_NEG_BUFFER on class /SCMB/CL_DF_DOCUMENT has no exception.
Method REFRESH_REF_BUFFER Signature
Method REFRESH_REF_BUFFER on class /SCMB/CL_DF_DOCUMENT has no parameter.
Method REFRESH_REF_BUFFER on class /SCMB/CL_DF_DOCUMENT has no exception.
Method RENAME_DOCUMENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
EO_DOCUMENT | Call by reference | Object reference (TYPE REF TO) | /SCMB/CL_DF_DOCUMENT | Belegfluss: Belegverwaltung | 20031010 | ||
| 2 | Exporting |
EV_DOCUMENT_ID | Call by reference | Type reference (TYPE) | /SCMB/DF_DOC_ID | Belegfluss: Beleg-ID (GUID) | 20031010 | ||
| 3 | Exporting |
EV_DOCUMENT_TYPE | Call by reference | Type reference (TYPE) | /SCMB/DF_CATEGORY | Belegfluss: Belegtyp | 20031010 | ||
| 4 | Importing |
IS_DOCUMENT | Call by reference | Type reference (TYPE) | /SCMB/DF_DOCUMENT | Belegfluss: Belegidentifikation | 20031013 | ||
| 5 | Importing |
IS_DOCUMENTX | Call by reference | Type reference (TYPE) | /SCMB/DF_DOCUMENTX | Belegfluss: Belegidentifikation | 20130211 | ||
| 6 | Importing |
IV_DOCUMENT | Call by reference | Type reference (TYPE) | /SCMB/STRINGVAL | Document number to be set | 20031013 | ||
| 7 | Importing |
IV_ITEM | Call by reference | Type reference (TYPE) | /SCMB/STRINGVAL | Item number to be set | 20060830 | ||
| 8 | Importing |
IV_PARTNER | Call by reference | Type reference (TYPE) | /SCMB/STRINGVAL | Partner ID to be set | 20060828 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | /SCMB/CX_DFI_DOCUMENT |
Belegfluss: Belegfehler (Detail) | 20031010 | |
| 2 | /SCMB/CX_DFI_DOCUMENT_SETUP |
Belegfluss: Fehler in der Belegverwaltung | 20061120 | |
| 3 | /SCMB/CX_DF_DOCUMENT |
Belegfluss: Belegfehler | 20060920 |
Method SEARCH Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_DOC | Call by reference | Type reference (TYPE) | /SCMB/DF_DOC_TBL | Belegfluss: Belegreferenzen | 20021022 | ||
| 2 | Exporting |
ET_DOC_KEY | Call by reference | Type reference (TYPE) | /SCMB/DF_DOC_KEY_TBL | Document Flow: Document Keys | 20080506 | ||
| 3 | Importing |
IT_CRITERIA | Call by reference | Type reference (TYPE) | /SCMB/DF_DOCUMENT_CRITERIA_TBL | Belegfluss: Kriterien Belegauswahl | 20021022 | ||
| 4 | Importing |
IV_CATEGORY | Call by reference | Type reference (TYPE) | /SCMB/DF_CATEGORY | Belegfluss: Belegtyp | 20021022 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | /SCMB/CX_DFI_DOCUMENT |
Document Flow: Document Error (Detail) | 20080506 | |
| 2 | /SCMB/CX_DFI_DOCUMENT_SETUP |
Document Flow: Error in Document Administration | 20080506 | |
| 3 | /SCMB/CX_DF_DOCUMENT |
Document Flow: Document Error | 20080506 |
Method SET_ATTRIBUTES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IO_DF_DOC | Call by reference | Object reference (TYPE REF TO) | /SCMB/CL_DF_DOC | Belegfluss: Belegidentifikation | 20021018 | ||
| 2 | Importing |
IO_DF_DOCUMENT | Call by reference | Object reference (TYPE REF TO) | /SCMB/CL_DF_DOCUMENT | Belegfluss: Belegverwaltung | 20040219 | ||
| 3 | Importing |
IS_DOCUMENT | Call by reference | Type reference (TYPE) | /SCMB/DF_DOCUMENT | Belegfluss: Belegidentifikation | 20021018 | ||
| 4 | Importing |
IS_DOCUMENTX | Call by reference | Type reference (TYPE) | /SCMB/DF_DOCUMENTX | Belegfluss: Belegidentifikation | 20130211 |
Method SET_ATTRIBUTES on class /SCMB/CL_DF_DOCUMENT has no exception.
Method SET_DOCIDX Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_DOCIDX | Call by reference | Type reference (TYPE) | /SCMB/DF_DOCIDX | Belegfluss: Index Beleg | 20090212 |
Method SET_DOCIDX on class /SCMB/CL_DF_DOCUMENT has no exception.
History
| Last changed by/on | SAP | 20110908 |
| SAP Release Created in | 401 |
