SAP ABAP Class CL_CFX_BI_DOCUMENT (Document for cFolders Backend Integration)
Hierarchy
☛
SAP_APPL (Software Component) Logistics and Accounting
⤷
CA (Application Component) Cross-Application Components
⤷
CFX_BI_BOM (Package) cFolders Backend Integration, BOMs
SAP_APPL (Software Component) Logistics and Accounting⤷
CA (Application Component) Cross-Application Components⤷
CFX_BI_BOM (Package) cFolders Backend Integration, BOMsMeta Relationship - Using
| # | Relationship type | Using | Short Description | Created on |
|---|---|---|---|---|
| 1 | Inheritance (c INHERITING FROM c_ref) | CL_CFX_BI_FOLDER_OBJECT | Folder Object for cFolders Backend Integration | 20020523 |
Properties
| Class | CL_CFX_BI_DOCUMENT | |
| Short Description | Document for cFolders Backend Integration | |
| Super Class | CL_CFX_BI_FOLDER_OBJECT | Folder Object for cFolders Backend Integration |
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | CFX_BI_BOM | cFolders Backend Integration, BOMs |
| Created | 20020523 | SAP |
| Last change | 20100310 | 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 CL_CFX_BI_DOCUMENT has no interface implemented.
Friends
Class CL_CFX_BI_DOCUMENT has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | KS_STORAGE_CAT_KPRO |
Static Attribute | Private | Type reference (TYPE) | DMS_DATA_CARRIER | DMS: Data carrier/Storage for DVS | 20020904 | ||
| 2 | KS_STORAGE_CAT_NO_KPRO |
Static Attribute | Private | Type reference (TYPE) | DMS_DATA_CARRIER | DMS: Data carrier/Storage for DVS | 20020904 | ||
| 3 | KS_STORAGE_CAT_NO_KPRO_0 |
Static Attribute | Private | Type reference (TYPE) | DMS_DATA_CARRIER | DMS: Data carrier/Storage for DVS | 20020904 | ||
| 4 | KT_STORAGE_CAT_KPRO |
Static Attribute | Private | Type reference (TYPE) | DMS_TBL_DATA_CARRIER | Table Type for DMS_DATA_CARRIER | 20020904 | ||
| 5 | KT_STORAGE_CAT_NO_KPRO |
Static Attribute | Private | Type reference (TYPE) | DMS_TBL_DATA_CARRIER | Table Type for DMS_DATA_CARRIER | 20020904 | ||
| 6 | KT_STORAGE_CAT_NO_KPRO_0 |
Static Attribute | Private | Type reference (TYPE) | DMS_TBL_DATA_CARRIER | Table Type for DMS_DATA_CARRIER | 20020904 | ||
| 7 | K_FRONTEND_TYPE |
Static Attribute | Private | Type reference (TYPE) | TYPDT | Data Carrier Type | 20020904 | ||
| 8 | MS_DOC_FILE |
Instance attribute | Public | Type reference (TYPE) | CVAPI_DOC_FILE | DMS: Originals of a Document | 20020524 | ||
| 9 | MS_DRAW |
Instance attribute | Public | Type reference (TYPE) | DRAW | Document Info Record | 20020523 | ||
| 10 | MS_TDWA |
Instance attribute | Public | Type reference (TYPE) | TDWA | Document types | 20020702 | ||
| 11 | M_BS_ID |
Instance attribute | Public | Type reference (TYPE) | CFX_BI_T_LO_DOC_ID | Logical ID of a Document | 20020624 | ||
| 12 | M_DCTYPE |
Instance attribute | Public | Type reference (TYPE) | DRAW-DTTRG | Name of data carrier | 20020702 | ||
| 13 | M_DMS_DOC_CREATED |
Instance attribute | Public | Type reference (TYPE) | ABAP_BOOL | DMS Document was Generated | 20020701 | ||
| 14 | M_DOKNR_TEMPLATE |
Instance attribute | Public | Type reference (TYPE) | DOKNR | Document number | 20020524 | ||
| 15 | M_DOKTL_TEMPLATE |
Instance attribute | Public | Type reference (TYPE) | DOKTL_D | Document Part | 20020524 | ||
| 16 | M_DOKVR_TEMPLATE |
Instance attribute | Public | Type reference (TYPE) | DOKVR | Document version | 20020524 | ||
| 17 | M_EXPLODED |
Instance attribute | Private | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Already Exploded | 20030103 | |
| 18 | M_NUM_ORIG_FILES |
Instance attribute | Public | Type reference (TYPE) | CFX_BI_T_NUM_ORIG_FILES | Number of Original Files in this Document | 20020524 | ||
| 19 | SC_DAPPL |
Constant | Public | Type reference (TYPE) | STRING | 'DAPPL' | 20050407 | ||
| 20 | SC_DESCRIPTION |
Constant | Public | Type reference (TYPE) | STRING | 'DESCRIPTION' | 20050407 | ||
| 21 | SC_DOKAR |
Constant | Public | Type reference (TYPE) | STRING | 'DOKAR' | 20050407 | ||
| 22 | SC_DOKNR |
Constant | Public | Type reference (TYPE) | STRING | 'DOKNR' | 20050407 | ||
| 23 | SC_DOKTL |
Constant | Public | Type reference (TYPE) | STRING | 'DOKTL' | 20050407 | ||
| 24 | SC_DOKVR |
Constant | Public | Type reference (TYPE) | STRING | 'DOKVR' | 20050407 | ||
| 25 | SC_LO_OBJID |
Constant | Public | Type reference (TYPE) | STRING | 'LO_OBJID' | 20050407 | ||
| 26 | SC_STORAGE_CAT |
Constant | Public | Type reference (TYPE) | STRING | 'STORAGE_CAT' | 20050407 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | AUX_SET_DOCUMENTTYPE |
Instance method | Private | Method | Change document type | 20020904 |
| 2 | CHECK_BS_EXIST |
Instance method | Private | Method | Is the Document Already in the Backend System? Yes => Error | 20020702 |
| 3 | CHECK_ECM_HIST_REQ |
Instance method | Private | Method | Is a Change Number Needed for Creation? | 20020702 |
| 4 | CLASS_CONSTRUCTOR |
Static method | Public | Constructor | . | 20020904 |
| 5 | CONSTRUCTOR |
Instance method | Public | Constructor | Constructor | 20020523 |
| 6 | EXPLODE_BS |
Instance method | Public | Method | Explode Document BOM in the Back-End System | 20030103 |
| 7 | GET_DATA_AS_STRUCTURE |
Instance method | Public | Method | Read Object Data as Structure | 20020624 |
| 8 | GET_DOCUMENT_ALV |
Instance method | Public | Method | Lines for ALV | 20020524 |
| 9 | INITIALIZE_FROM_BS |
Static method | Public | Method | Load Values from BS, Create One Object for each Original | 20020528 |
| 10 | SET_APPNR |
Instance method | Public | Method | Set Application Number (if KPro is Not Used) | 20020702 |
| 11 | SET_BACKEND_SYSTEM_KEY |
Instance method | Public | Method | Change Key in Backend System | 20020702 |
| 12 | SET_BACKEND_SYSTEM_TEMPLATE |
Instance method | Public | Method | Change Template in Backend System | 20020702 |
| 13 | SET_DATA_FROM_STRUCTURE |
Instance method | Private | Method | Fill an Object with Data | 20020613 |
| 14 | SET_NUM_ORIG_FILES |
Instance method | Public | Method | Number of Original Files for All Docs with Same BS Key | 20020702 |
| 15 | SET_STORAGE_CAT |
Instance method | Public | Method | Storage Category | 20020802 |
| 16 | SET_WORKSTATION_APPLICATION |
Instance method | Public | Method | Workstation application | 20020826 |
Events
Class CL_CFX_BI_DOCUMENT has no event.
Types
Class CL_CFX_BI_DOCUMENT has no local type.
Method Signatures
Method AUX_SET_DOCUMENTTYPE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
I_DOKAR | Call by reference | Type reference (TYPE) | DOKAR | Dokumentart | 20020904 | ||
| 2 |  Returning |
R_VALID | Value transfer | Type reference (TYPE) | ABAP_BOOL | Dokumentart (i_dokar) gültig, d.h. im Customizing gepflegt | 20020904 |
Method AUX_SET_DOCUMENTTYPE on class CL_CFX_BI_DOCUMENT has no exception.
Method CHECK_BS_EXIST Signature
Method CHECK_BS_EXIST on class CL_CFX_BI_DOCUMENT has no parameter.
Method CHECK_BS_EXIST on class CL_CFX_BI_DOCUMENT has no exception.
Method CHECK_ECM_HIST_REQ Signature
Method CHECK_ECM_HIST_REQ on class CL_CFX_BI_DOCUMENT has no parameter.
Method CHECK_ECM_HIST_REQ on class CL_CFX_BI_DOCUMENT has no exception.
Method CLASS_CONSTRUCTOR Signature
Method CLASS_CONSTRUCTOR on class CL_CFX_BI_DOCUMENT has no parameter.
Method CLASS_CONSTRUCTOR on class CL_CFX_BI_DOCUMENT has no exception.
Method CONSTRUCTOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IP_CFOLDERS_SYSTEM | Call by reference | Object reference (TYPE REF TO) | CL_CFX_BI_CFOLDERS_SYSTEM | cFolders System für cFolders Backendintegration | 20020523 |
Method CONSTRUCTOR on class CL_CFX_BI_DOCUMENT has no exception.
Method EXPLODE_BS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
E_ERROR | Call by reference | Type reference (TYPE) | ABAP_BOOL | Fehler ? | 20030103 | ||
| 2 | Importing |
I_ERROR_TRANSPORT_STATUS | Call by reference | Type reference (TYPE) | CFX_BI_T_TRANSPORT_STATUS | Transportstatus von/nach cFolders System | 20030103 | ||
| 3 | Importing |
I_MSG_TYPE | Call by reference | Type reference (TYPE) | SYMSGTY | 'I' | Nachrichten, Nachrichtentyp | 20030103 |
Method EXPLODE_BS on class CL_CFX_BI_DOCUMENT has no exception.
Method GET_DATA_AS_STRUCTURE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ES_DOCUMENT_ORIGINAL | Call by reference | Type reference (TYPE) | CFX_BI_TS_DOCUMENT_ORIGINAL | Daten des Originals im BS | 20020624 |
Method GET_DATA_AS_STRUCTURE on class CL_CFX_BI_DOCUMENT has no exception.
Method GET_DOCUMENT_ALV Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ES_DOCUMENT_ALV | Call by reference | Type reference (TYPE) | CFX_BI_TS_DOCUMENT_ALV | Dokument für ALV grid | 20020524 |
Method GET_DOCUMENT_ALV on class CL_CFX_BI_DOCUMENT has no exception.
Method INITIALIZE_FROM_BS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IP_CFOLDERS_SYSTEM | Call by reference | Object reference (TYPE REF TO) | CL_CFX_BI_CFOLDERS_SYSTEM | cFolders System | 20020613 | ||
| 2 | Importing |
IS_DOCUMENT_KEY | Call by reference | Type reference (TYPE) | CFX_BI_TS_DOCUMENT | Schlüssel des Dokument im BS | 20020613 | ||
| 3 | Returning |
RT_DOCUMENT | Value transfer | Type reference (TYPE) | CFX_BI_TT_DOCUMENT_OBJ | Tabelle von (cFolders) Dokumentobjekten | 20020613 |
Method INITIALIZE_FROM_BS on class CL_CFX_BI_DOCUMENT has no exception.
Method SET_APPNR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IP_DOCUMENT | Call by reference | Object reference (TYPE REF TO) | CL_CFX_BI_DOCUMENT | Dokuement für cFolders Backendintegration | 20020702 |
Method SET_APPNR on class CL_CFX_BI_DOCUMENT has no exception.
Method SET_BACKEND_SYSTEM_KEY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
I_DOKAR | Call by reference | Type reference (TYPE) | DOKAR | Dokumentart | 20020702 | ||
| 2 | Importing |
I_DOKNR | Call by reference | Type reference (TYPE) | DOKNR | Dokumentnummer | 20020702 | ||
| 3 | Importing |
I_DOKTL | Call by reference | Type reference (TYPE) | DOKTL_D | Teildokument | 20020702 | ||
| 4 | Importing |
I_DOKVR | Call by reference | Type reference (TYPE) | DOKVR | Dokumentversion | 20020702 |
Method SET_BACKEND_SYSTEM_KEY on class CL_CFX_BI_DOCUMENT has no exception.
Method SET_BACKEND_SYSTEM_TEMPLATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
I_DOKNR_TEMPLATE | Call by reference | Type reference (TYPE) | DOKNR | Dokumentnummer | 20020702 | ||
| 2 | Importing |
I_DOKTL_TEMPLATE | Call by reference | Type reference (TYPE) | DOKTL_D | Teildokument | 20020702 | ||
| 3 | Importing |
I_DOKVR_TEMPLATE | Call by reference | Type reference (TYPE) | DOKVR | Dokumentversion | 20020702 |
Method SET_BACKEND_SYSTEM_TEMPLATE on class CL_CFX_BI_DOCUMENT has no exception.
Method SET_DATA_FROM_STRUCTURE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IS_DOCUMENT_ORIGINAL | Call by reference | Type reference (TYPE) | CFX_BI_TS_DOCUMENT_ORIGINAL | Daten des Originals im BS | 20020613 |
Method SET_DATA_FROM_STRUCTURE on class CL_CFX_BI_DOCUMENT has no exception.
Method SET_NUM_ORIG_FILES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IT_DOCUMENTS | Call by reference | Type reference (TYPE) | CFX_BI_TT_DOCUMENT_OBJ | Tabelle von Dokumentobjekten | 20020702 | ||
| 2 | Importing |
I_NUM_ORIG_FILES | Call by reference | Type reference (TYPE) | CFX_BI_T_NUM_ORIG_FILES | Zahl der Originaldateien | 20020702 |
Method SET_NUM_ORIG_FILES on class CL_CFX_BI_DOCUMENT has no exception.
Method SET_STORAGE_CAT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
I_STORAGE_CAT | Call by reference | Type reference (TYPE) | CV_STORAGE_CAT | Ablagekategorie für Originaldateien | 20020802 | ||
| 2 | Returning |
R_VALID | Value transfer | Type reference (TYPE) | ABAP_BOOL | Ablagekategorie gültig, d.h. im Customizing gepflegt | 20020904 |
Method SET_STORAGE_CAT on class CL_CFX_BI_DOCUMENT has no exception.
Method SET_WORKSTATION_APPLICATION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
I_WORKSTATION_APPLICATION | Call by reference | Type reference (TYPE) | DAPPL | Workstation-Applikation | 20020826 | ||
| 2 | Returning |
R_VALID | Value transfer | Type reference (TYPE) | ABAP_BOOL | Wert gültig, d.h. im Customizing gepflegt | 20020904 |
Method SET_WORKSTATION_APPLICATION on class CL_CFX_BI_DOCUMENT has no exception.
History
| Last changed by/on | SAP | 20100310 |
| SAP Release Created in | 2002_1_46C |
