SAP ABAP Class /SCMB/CL_DF_CORE (Document Flow Core Functions)

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

Properties

Class	/SCMB/CL_DF_CORE
Short Description	Document Flow Core Functions
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	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	/SCMB/CL_DF_LINK2	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)

Interfaces

Class /SCMB/CL_DF_CORE has no interface implemented.

Friends

Class /SCMB/CL_DF_CORE has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GT_LINKATTR_AGENT	Static Attribute	Private	☐	See coding			Agents of Link Attribute Persistent Objects	20090629
2	GV_READ_LINK_MASS	Static Attribute	Private	☐	Type reference (TYPE)	FLAG		Mass reading of link is enabled	20090629

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_LINKATTR_AGENT	Static method	Public	Method	Add new link attribute agent to buffer	20110826
2	CLASS_CONSTRUCTOR	Static method	Public	Constructor	CLASS_CONSTRUCTOR	20090629
3	DEL_LINK_BY_DOCKEY	Static method	Public	Method	Delete Link of Documents	20090629
4	GET_DOCS_BY_ATTR	Static method	Public	Method	Get Documents Based on Attributes	20090629
5	GET_DOCS_BY_CRITERIA	Static method	Public	Method	Get Documents Based on Selection Criteria	20090629
6	GET_DOCS_BY_KEY	Static method	Public	Method	Get Documents by Document Key	20090629
7	GET_DOC_BY_ATTR	Static method	Public	Method	Get Document Based on Attributes	20090629
8	GET_DOC_BY_KEY	Static method	Public	Method	Get Document by Document Key	20090629
9	GET_LINKATTR_BY_LINKOBJ	Static method	Public	Method	Get Link Attribute of Link Object	20090629
10	GET_LINKATTR_NAME	Static method	Private	Method	Get Link Attribute Names of Link Type	20090629
11	GET_LINKS_BY_DOCKEY	Static method	Public	Method	Get Links by Document Key	20090629
12	GET_LINKS_BY_DOCKEY_MULTI	Static method	Private	Method	Get Links of Multiply Documents (OBL mass read)	20090629
13	GET_LINKS_BY_DOCKEY_MULTI_OLD	Static method	Private	Method	Get Links of Multiply Documents (OBL single read)	20090629
14	GET_LINKS_BY_DOCKEY_SINGLE	Static method	Private	Method	Get Links of Single Document	20090629
15	HANDLE_TRANSACTION_FINISHED	Static method	Public	Event handling method	Initialize Buffer After Transaction Finished	20090629
16	INITIALIZE	Static method	Public	Method	Initialize All Document Flow Buffers	20090629
17	LOAD_LINKATTR_BY_LINKOBJ	Static method	Public	Method	Load Attributes of Link Objects (mass read)	20090629
18	REFRESH	Static method	Public	Method	Refresh Document Flow Database Read Buffers	20090629
19	SET_DOCS_BY_ATTR	Static method	Public	Method	Set Documents Based on Attributes	20090629
20	SET_LINKATTR_BY_LINKOBJ	Static method	Public	Method	Set Link Attribute of Link Object	20090629
21	SET_LINK_BY_DOCKEY	Static method	Public	Method	Set Link of Documents	20090629

Events

Class /SCMB/CL_DF_CORE has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TYP_S_DOC_LINK	Public	See coding		Document's Link Objects	20090629	BEGIN OF typ_s_doc_link, doc_key TYPE /scmb/s_df_doc_key, link_obj TYPE REF TO /scmb/cl_df_link2, END OF typ_s_doc_link
2	TYP_S_DOC_OBJ_IDX	Public	See coding		Document Object by Index	20090629	BEGIN OF typ_s_doc_obj_idx, doc_idx TYPE /scmb/df_docidx, doc_obj TYPE REF TO /scmb/cl_df_document2, END OF typ_s_doc_obj_idx
3	TYP_S_LINK_OBJ_IDX	Public	See coding		Link Object by Index	20090629	BEGIN OF typ_s_link_obj_idx, link_idx TYPE /scmb/df_relidx, link_obj TYPE REF TO /scmb/cl_df_link2, END OF typ_s_link_obj_idx
4	TYP_T_DOC_LINK	Public	See coding		Document's Link Objects Table	20090629	typ_t_doc_link TYPE STANDARD TABLE OF typ_s_doc_link WITH NON-UNIQUE KEY doc_key
5	TYP_T_DOC_OBJ_IDX	Public	See coding		Document Object by Index Table	20090629	typ_t_doc_obj_idx TYPE STANDARD TABLE OF typ_s_doc_obj_idx WITH NON-UNIQUE KEY doc_idx
6	TYP_T_LINKATTR_NAME	Private	See coding		Link Attribute Names Table	20090629	TYP_T_LINKATTR_NAME TYPE STANDARD TABLE OF oblprop WITH DEFAULT KEY
7	TYP_T_LINK_OBJ_IDX	Public	See coding		Link Object by Index Table	20090629	typ_t_link_obj_idx TYPE STANDARD TABLE OF typ_s_link_obj_idx WITH NON-UNIQUE KEY link_idx

Method Signatures

Method ADD_LINKATTR_AGENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_AGENT	Call by reference	☐	Object reference (TYPE REF TO)	OBJECT		Link attribute agent	20110826

Method ADD_LINKATTR_AGENT on class /SCMB/CL_DF_CORE has no exception.

Method CLASS_CONSTRUCTOR Signature

Method CLASS_CONSTRUCTOR on class /SCMB/CL_DF_CORE has no parameter.
Method CLASS_CONSTRUCTOR on class /SCMB/CL_DF_CORE has no exception.

Method DEL_LINK_BY_DOCKEY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_DOCKEY_FROM	Call by reference	☐	Type reference (TYPE)	/SCMB/S_DF_DOC_KEY			20090629
2	Importing	IS_DOCKEY_TO	Call by reference	☐	Type reference (TYPE)	/SCMB/S_DF_DOC_KEY			20090629
3	Importing	IV_LINK_TYPE	Call by reference	☐	Type reference (TYPE)	OBLRELTYPE			20090629

#	Exception	Resumable	Description	Created on
1	/SCMB/CX_DFI_RELATION	☐		20090629

Method GET_DOCS_BY_ATTR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_DOC_OBJ_IDX	Call by reference	☐	Type reference (TYPE)	TYP_T_DOC_OBJ_IDX		Document Object by Index Table	20090629
2	Importing	IT_DOCUMENT	Call by reference	☑	Type reference (TYPE)	/SCMB/DF_DOCUMENT_TBL		Document Flow: Document	20090629
3	Importing	IT_DOCUMENTX	Call by reference	☑	Type reference (TYPE)	/SCMB/DF_DOCUMENTX_TBL		Document Flow: Document (xstring)	20130211

#	Exception	Resumable	Description	Created on
1	/SCMB/CX_DFI_DOCUMENT	☐		20090629
2	/SCMB/CX_DF_DOCUMENT	☐		20090629

Method GET_DOCS_BY_CRITERIA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_DOC_OBJ	Call by reference	☐	Type reference (TYPE)	/SCMB/T_DF_DOC_OBJ		Document Objects	20090629
2	Importing	IT_DOCUMENT_CRITERIA	Call by reference	☐	Type reference (TYPE)	/SCMB/DF_DOCUMENT_CRITERIA_TBL		Document Flow: Criteria for Document Selection	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 GET_DOCS_BY_KEY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_DOC_OBJ	Call by reference	☐	Type reference (TYPE)	/SCMB/T_DF_DOC_OBJ		Document Objects	20090629
2	Importing	IT_DOC_KEY	Call by reference	☐	Type reference (TYPE)	/SCMB/T_DF_DOC_KEY		Document Key Table	20090629

#	Exception	Resumable	Description	Created on
1	/SCMB/CX_DFI_DOCUMENT	☐		20090629

Method GET_DOC_BY_ATTR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_DOCUMENT	Call by reference	☑	Type reference (TYPE)	/SCMB/DF_DOCUMENT		Document Flow: Document Identification	20090629
2	Importing	IS_DOCUMENTX	Call by reference	☑	Type reference (TYPE)	/SCMB/DF_DOCUMENTX		Document Flow: Document Identification (xstring)	20130211
3	Returning	RO_DOC_OBJ	Value transfer	☐	Object reference (TYPE REF TO)	/SCMB/CL_DF_DOCUMENT2		Document	20090629

#	Exception	Resumable	Description	Created on
1	/SCMB/CX_DFI_DOCUMENT	☐		20090629
2	/SCMB/CX_DF_DOCUMENT	☐		20090629

Method GET_DOC_BY_KEY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_DOC_KEY	Call by reference	☐	Type reference (TYPE)	/SCMB/S_DF_DOC_KEY		Document Key	20090629
2	Returning	RO_DOC_OBJ	Value transfer	☐	Object reference (TYPE REF TO)	/SCMB/CL_DF_DOCUMENT2		Document	20090629

#	Exception	Resumable	Description	Created on
1	/SCMB/CX_DFI_DOCUMENT	☐		20090629

Method GET_LINKATTR_BY_LINKOBJ Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_LINK_ATTR	Call by reference	☐	Type reference (TYPE)	/SCMB/CL_DF_LINK2=>TYP_T_LINK_ATTR			20090629
2	Exporting	ET_LINK_ATTRX	Call by reference	☐	Type reference (TYPE)	/SCMB/CL_DF_LINK2=>TYP_T_LINK_ATTRX		Link Attributes Table Type (xstring)	20130211
3	Importing	IO_LINK_OBJ	Call by reference	☐	Object reference (TYPE REF TO)	/SCMB/CL_DF_LINK2			20090629

#	Exception	Resumable	Description	Created on
1	/SCMB/CX_DFI_ATTRIBUTE	☐		20090629

Method GET_LINKATTR_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_LINKATTR_NAME	Call by reference	☐	Type reference (TYPE)	TYP_T_LINKATTR_NAME			20090629
2	Importing	IV_LINK_TYPE	Call by reference	☐	Type reference (TYPE)	OBLRELTYPE			20090629

Method GET_LINKATTR_NAME on class /SCMB/CL_DF_CORE has no exception.

Method GET_LINKS_BY_DOCKEY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_DOC_LINK	Call by reference	☐	Type reference (TYPE)	TYP_T_DOC_LINK		Document's Link Objects Table	20090629
2	Importing	IT_DOC_KEY	Call by reference	☐	Type reference (TYPE)	/SCMB/T_DF_DOC_KEY		Document Key Table	20090629
3	Importing	IT_RELATION_TYPE	Call by reference	☑	Type reference (TYPE)	/SCMB/DF_RELATION_TYPE_TBL		Document Flow: Link Category	20090629
4	Importing	IV_COMPLETENESS	Call by reference	☑	Type reference (TYPE)	/SCMB/DF_COMPLETENESS	/SCMB/CL_DF_RELATION_TYPE=>GC_ONEWAY	Document Flow: Completeness	20090629
5	Importing	IV_MAXIMAL_CHAIN	Call by reference	☑	Type reference (TYPE)	/SCMB/DF_NET_CHAIN		Document Flow: Maximum Chain	20090629
6	Importing	IV_RELATION_BACKWARD	Call by reference	☑	Type reference (TYPE)	/SCMB/DF_RELATION_CNT	0	Document Flow: Number of Links	20090629
7	Importing	IV_RELATION_FORWARD	Call by reference	☑	Type reference (TYPE)	/SCMB/DF_RELATION_CNT	0	Document Flow: Number of Links	20090629

#	Exception	Resumable	Description	Created on
1	/SCMB/CX_DFI_RELATION	☐		20090629

Method GET_LINKS_BY_DOCKEY_MULTI Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_DOC_LINK	Call by reference	☐	Type reference (TYPE)	TYP_T_DOC_LINK		Document's Link Objects Table	20090629
2	Importing	IT_DOC_KEY	Call by reference	☐	Type reference (TYPE)	/SCMB/T_DF_DOC_KEY		Document Key Table	20090629
3	Importing	IT_RELATION_TYPE	Call by reference	☑	Type reference (TYPE)	/SCMB/DF_RELATION_TYPE_TBL		Document Flow: Link Category	20090629
4	Importing	IV_RELATION_BACKWARD	Call by reference	☑	Type reference (TYPE)	/SCMB/DF_RELATION_CNT	0	Document Flow: Number of Links	20090629
5	Importing	IV_RELATION_FORWARD	Call by reference	☑	Type reference (TYPE)	/SCMB/DF_RELATION_CNT	0	Document Flow: Number of Links	20090629

#	Exception	Resumable	Description	Created on
1	/SCMB/CX_DFI_RELATION	☐		20090629

Method GET_LINKS_BY_DOCKEY_MULTI_OLD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_DOC_LINK	Call by reference	☐	Type reference (TYPE)	TYP_T_DOC_LINK		Document's Link Objects Table	20090629
2	Importing	IT_DOC_KEY	Call by reference	☐	Type reference (TYPE)	/SCMB/T_DF_DOC_KEY		Document Key Table	20090629
3	Importing	IT_RELATION_TYPE	Call by reference	☑	Type reference (TYPE)	/SCMB/DF_RELATION_TYPE_TBL		Document Flow: Link Category	20090629
4	Importing	IV_RELATION_BACKWARD	Call by reference	☑	Type reference (TYPE)	/SCMB/DF_RELATION_CNT	0	Document Flow: Number of Links	20090629
5	Importing	IV_RELATION_FORWARD	Call by reference	☑	Type reference (TYPE)	/SCMB/DF_RELATION_CNT	0	Document Flow: Number of Links	20090629

#	Exception	Resumable	Description	Created on
1	/SCMB/CX_DFI_RELATION	☐		20090629

Method GET_LINKS_BY_DOCKEY_SINGLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_DOC_LINK	Call by reference	☐	Type reference (TYPE)	TYP_T_DOC_LINK		Document's Link Objects Table	20090629
2	Importing	IS_DOC_KEY	Call by reference	☐	Type reference (TYPE)	/SCMB/S_DF_DOC_KEY		Document Key	20090629
3	Importing	IT_RELATION_TYPE	Call by reference	☑	Type reference (TYPE)	/SCMB/DF_RELATION_TYPE_TBL		Document Flow: Link Category	20090629
4	Importing	IV_RELATION_BACKWARD	Call by reference	☑	Type reference (TYPE)	/SCMB/DF_RELATION_CNT	0	Document Flow: Number of Links	20090629
5	Importing	IV_RELATION_FORWARD	Call by reference	☑	Type reference (TYPE)	/SCMB/DF_RELATION_CNT	0	Document Flow: Number of Links	20090629

#	Exception	Resumable	Description	Created on
1	/SCMB/CX_DFI_RELATION	☐		20090629

Method HANDLE_TRANSACTION_FINISHED Signature

Method HANDLE_TRANSACTION_FINISHED on class /SCMB/CL_DF_CORE has no parameter.
Method HANDLE_TRANSACTION_FINISHED on class /SCMB/CL_DF_CORE has no exception.

Method INITIALIZE Signature

Method INITIALIZE on class /SCMB/CL_DF_CORE has no parameter.
Method INITIALIZE on class /SCMB/CL_DF_CORE has no exception.

Method LOAD_LINKATTR_BY_LINKOBJ Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_LINK_OBJ_IDX	Call by reference	☐	Type reference (TYPE)	TYP_T_LINK_OBJ_IDX			20090629

Method LOAD_LINKATTR_BY_LINKOBJ on class /SCMB/CL_DF_CORE has no exception.

Method REFRESH Signature

Method REFRESH on class /SCMB/CL_DF_CORE has no parameter.
Method REFRESH on class /SCMB/CL_DF_CORE has no exception.

Method SET_DOCS_BY_ATTR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_DOC_OBJ_IDX	Call by reference	☐	Type reference (TYPE)	TYP_T_DOC_OBJ_IDX		Document Object by Index Table	20090629
2	Importing	IT_DOCUMENT	Call by reference	☑	Type reference (TYPE)	/SCMB/DF_DOCUMENT_TBL		Document Flow: Document	20090629
3	Importing	IT_DOCUMENTX	Call by reference	☑	Type reference (TYPE)	/SCMB/DF_DOCUMENTX_TBL		Document Flow: Document (xstring)	20130211

#	Exception	Resumable	Description	Created on
1	/SCMB/CX_DF_DOCUMENT	☐		20090629

Method SET_LINKATTR_BY_LINKOBJ Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_LINK_OBJ	Call by reference	☐	Object reference (TYPE REF TO)	/SCMB/CL_DF_LINK2			20090629
2	Importing	IV_LINK_ATTR	Call by reference	☑	Type reference (TYPE)	STRING			20090629
3	Importing	IV_LINK_ATTRX	Call by reference	☑	Type reference (TYPE)	XSTRING			20130211

#	Exception	Resumable	Description	Created on
1	/SCMB/CX_DFI_ATTRIBUTE	☐		20090629

Method SET_LINK_BY_DOCKEY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_DOCKEY_FROM	Call by reference	☐	Type reference (TYPE)	/SCMB/S_DF_DOC_KEY			20090629
2	Importing	IS_DOCKEY_TO	Call by reference	☐	Type reference (TYPE)	/SCMB/S_DF_DOC_KEY			20090629
3	Importing	IV_LINK_ATTR	Call by reference	☑	Type reference (TYPE)	STRING			20090629
4	Importing	IV_LINK_ATTRX	Call by reference	☑	Type reference (TYPE)	XSTRING			20130211
5	Importing	IV_LINK_TYPE	Call by reference	☐	Type reference (TYPE)	OBLRELTYPE			20090629
6	Returning	RO_LINK_OBJ	Value transfer	☐	Object reference (TYPE REF TO)	/SCMB/CL_DF_LINK2			20090629

#	Exception	Resumable	Description	Created on
1	/SCMB/CX_DFI_ATTRIBUTE	☐		20090629
2	/SCMB/CX_DFI_RELATION	☐		20090629

History

Last changed by/on	SAP	20130531
SAP Release Created in	731