SAP ABAP Class /SCMB/CL_DF_DOCDAL (Document Data Access Layer)
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_DOCDAL | |
| Short Description | Document Data Access Layer | |
| 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 | 20090325 | SAP |
| Last change | 20130531 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
Class /SCMB/CL_DF_DOCDAL has no forward declaration.
Interfaces
Class /SCMB/CL_DF_DOCDAL has no interface implemented.
Friends
Class /SCMB/CL_DF_DOCDAL has no friend class.
Attributes
Class /SCMB/CL_DF_DOCDAL has no attribute.
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | GET_DOCID_BY_KEY |
Static method | Public | Method | Get ID of Documents Selected by Keys | 20090629 |
| 2 | GET_DOCID_BY_RNG |
Static method | Public | Method | Get ID of Documents Selected by Range | 20090629 |
| 3 | INITIALIZE |
Static method | Public | Method | Initialize Data Access Layer | 20090629 |
| 4 | READ_DOC |
Static method | Public | Method | Read Documents from Database | 20090629 |
| 5 | REFRESH |
Static method | Public | Method | Clear Buffers of Loaded Documents | 20090629 |
| 6 | SET_DOCID_BY_KEY |
Static method | Public | Method | Set ID of Documents to Selected Keys | 20090629 |
| 7 | WRITE_DOC |
Static method | Public | Method | Write Documents to Database | 20090629 |
Events
Class /SCMB/CL_DF_DOCDAL has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | TYP_S_DB_COUNT | Public | See coding | Number of Processed DB Table Rows | 20090629 | BEGIN OF typ_s_db_count,
tabname TYPE tabname,
dbcnt_insert TYPE sy-dbcnt,
dbcnt_update TYPE sy-dbcnt,
dbcnt_delete TYPE sy-dbcnt,
END OF typ_s_db_count
|
|
| 2 | TYP_S_DOC | Public | See coding | Document | 20090629 | BEGIN OF typ_s_doc,
guid TYPE /scmb/df_guid,
category TYPE /scmb/df_category,
guid_app TYPE /scmb/df_guid,
logsys TYPE logsys,
bor_type TYPE sibftypeid,
bor_id TYPE sibfboriid,
bskey TYPE sld_bskey,
characteristic TYPE string,
characteristicx TYPE xstring,
END OF typ_s_doc
|
|
| 3 | TYP_S_DOC_ID | Public | See coding | Document ID | 20090629 | BEGIN OF typ_s_doc_id,
guid TYPE /scmb/df_guid,
END OF typ_s_doc_id
|
|
| 4 | TYP_S_DOC_KEY_ID | Public | See coding | Document Key - ID mapping | 20090629 | BEGIN OF typ_s_doc_key_id,
category TYPE /scmb/df_category,
guid_app TYPE /scmb/df_guid,
characteristic TYPE /scmb/stringval,
characteristicx TYPE /scmb/xstringval,
guid TYPE /scmb/df_guid,
END OF typ_s_doc_key_id
|
|
| 5 | TYP_S_DOC_SELOPT | Public | See coding | Document Selection Structure | 20090629 | BEGIN OF typ_s_doc_selopt,
sign TYPE /scmb/df_document_criteria-sign,
option TYPE /scmb/df_document_criteria-option,
low TYPE /scmb/df_document_criteria-low,
high TYPE /scmb/df_document_criteria-high,
END OF typ_s_doc_selopt
|
|
| 6 | TYP_S_DOC_SEL_KEY | Public | See coding | Document Selection by Key | 20090629 | BEGIN OF typ_s_doc_sel_key,
category TYPE /scmb/df_category,
guid_app TYPE /scmb/df_guid,
characteristic TYPE /scmb/stringval,
characteristicx TYPE /scmb/xstringval,
docidx TYPE /scmb/df_docidx,
END OF typ_s_doc_sel_key
|
|
| 7 | TYP_S_DOC_SEL_RES | Public | See coding | Document Selection Result | 20090629 | BEGIN OF typ_s_doc_sel_res,
docidx TYPE /scmb/df_docidx,
category TYPE /scmb/df_category,
guid TYPE /scmb/df_guid,
END OF typ_s_doc_sel_res
|
|
| 8 | TYP_S_DOC_SEL_RNG | Public | See coding | Document Selection by Range | 20090629 | BEGIN OF typ_s_doc_sel_rng,
fieldname TYPE /scmb/df_document_criteria-fieldname,
selopt_tab TYPE typ_t_doc_selopt,
END OF typ_s_doc_sel_rng
|
|
| 9 | TYP_T_DB_COUNT | Public | See coding | Number of Processed DB Table Rows Table | 20090629 | typ_t_db_count TYPE STANDARD TABLE OF typ_s_db_count
WITH NON-UNIQUE KEY tabname
|
|
| 10 | TYP_T_DOC | Public | See coding | Document Table | 20090629 | typ_t_doc TYPE STANDARD TABLE OF typ_s_doc
WITH NON-UNIQUE KEY guid
|
|
| 11 | TYP_T_DOC_ID | Public | See coding | Documen ID Table | 20090629 | typ_t_doc_id TYPE STANDARD TABLE OF typ_s_doc_id WITH DEFAULT KEY
|
|
| 12 | TYP_T_DOC_KEY_ID | Public | See coding | Document Key - ID mapping Table | 20090629 | typ_t_doc_key_id TYPE STANDARD TABLE OF typ_s_doc_key_id
WITH NON-UNIQUE KEY guid
|
|
| 13 | TYP_T_DOC_SELOPT | Public | See coding | Document Selection Table Type | 20090629 | typ_t_doc_selopt TYPE STANDARD TABLE OF typ_s_doc_selopt WITH DEFAULT KEY
|
|
| 14 | TYP_T_DOC_SEL_KEY | Public | See coding | Document Selection by Key Table | 20090629 | typ_t_doc_sel_key TYPE STANDARD TABLE OF typ_s_doc_sel_key
WITH NON-UNIQUE KEY docidx
|
|
| 15 | TYP_T_DOC_SEL_RES | Public | See coding | Document Selection Result Table | 20090629 | typ_t_doc_sel_res TYPE STANDARD TABLE OF typ_s_doc_sel_res
WITH NON-UNIQUE KEY docidx
|
|
| 16 | TYP_T_DOC_SEL_RNG | Public | See coding | Document Selection by Range Table | 20090629 | typ_t_doc_sel_rng TYPE STANDARD TABLE OF typ_s_doc_sel_rng
WITH NON-UNIQUE KEY fieldname
|
Method Signatures
Method GET_DOCID_BY_KEY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
ET_DOC_SEL_RES | Call by reference | Type reference (TYPE) | TYP_T_DOC_SEL_RES | Document Selection Result Table | 20090629 | ||
| 2 |  Importing |
IT_DOC_SEL_KEY | Call by reference | Type reference (TYPE) | TYP_T_DOC_SEL_KEY | Document Selection by Key Table | 20090629 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  /SCMB/CX_DFI_DOCUMENT |
20090629 |
Method GET_DOCID_BY_RNG Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_DOC_SEL_RES | Call by reference | Type reference (TYPE) | TYP_T_DOC_SEL_RES | Document Selection Result Table | 20090629 | ||
| 2 | Importing |
IT_DOC_SEL_RNG | Call by reference | Type reference (TYPE) | TYP_T_DOC_SEL_RNG | Document Selection by Range Table | 20090629 | ||
| 3 | Importing |
IV_CATEGORY | Call by reference | Type reference (TYPE) | /SCMB/DF_CATEGORY | Document Flow: Document Category | 20090629 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | /SCMB/CX_DFI_DOCUMENT |
20090629 |
Method INITIALIZE Signature
Method INITIALIZE on class /SCMB/CL_DF_DOCDAL has no parameter.
Method INITIALIZE on class /SCMB/CL_DF_DOCDAL has no exception.
Method READ_DOC 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) | TYP_T_DOC | Document Table | 20090629 | ||
| 2 | Importing |
IT_DOC_ID | Call by reference | Type reference (TYPE) | TYP_T_DOC_ID | Documen ID Table | 20090629 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | /SCMB/CX_DFI_DOCUMENT |
20090629 |
Method REFRESH Signature
Method REFRESH on class /SCMB/CL_DF_DOCDAL has no parameter.
Method REFRESH on class /SCMB/CL_DF_DOCDAL has no exception.
Method SET_DOCID_BY_KEY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IS_DOC_KEY_DELETE | Call by reference | Type reference (TYPE) | TYP_S_DOC_KEY_ID | Document Key - ID mapping | 20090629 | ||
| 2 | Importing |
IS_DOC_KEY_INSERT | Call by reference | Type reference (TYPE) | TYP_S_DOC_KEY_ID | Document Key - ID mapping | 20090629 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | /SCMB/CX_DFI_DOCUMENT |
20090629 |
Method WRITE_DOC Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_DB_COUNT | Call by reference | Type reference (TYPE) | TYP_T_DB_COUNT | Number of Processed DB Table Rows Table | 20090629 | ||
| 2 | Importing |
IT_DOC_DELETE | Call by reference | Type reference (TYPE) | TYP_T_DOC | Document Table | 20090629 | ||
| 3 | Importing |
IT_DOC_INSERT | Call by reference | Type reference (TYPE) | TYP_T_DOC | Document Table | 20090629 | ||
| 4 | Importing |
IT_DOC_UPDATE | Call by reference | Type reference (TYPE) | TYP_T_DOC | Document Table | 20090629 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | /SCMB/CX_DFI_DOCUMENT |
20090629 |
History
| Last changed by/on | SAP | 20130531 |
| SAP Release Created in | 732 |
