SAP ABAP Class CL_DOCUMENT_EXTRACT (Class for BAdI Impl.: DOCUMENT_EXTRACT)

Hierarchy

☛ BBPCRM (Software Component) BBPCRM
   ⤷ CA-DMS (Application Component) Document Management System
     ⤷ CV (Package) Application Development: R/3 Document Management

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_BADI_ESH_IF_OBJECT_DATA	Object data by list of object ids	20080326
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_BADI_INTERFACE	Tag Interface for BAdIs	20080326

Properties

Class	CL_DOCUMENT_EXTRACT
Short Description	Class for BAdI Impl.: DOCUMENT_EXTRACT
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	CV	Application Development: R/3 Document Management
Created	20080326	SAP
Last change	20130531	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)
2	CL_ESO_EXTRACTION_TOOLS	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
3	CVESO	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
4	CVKPR	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_BADI_ESH_IF_OBJECT_DATA	☐	☐	Object data by list of object ids	20080326
2	IF_BADI_INTERFACE	☐	☐	Tag Interface for BAdIs	20080326

Friends

Class CL_DOCUMENT_EXTRACT has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_NODE_DOCUMENT	Constant	Public	☐	Type reference (TYPE)	ESH_E_OM_NODE_NAME	CVESO_ESN_DOC_ROOT	Node: Document	20080326
2	GC_NODE_STRUC	Constant	Public	☐	Type reference (TYPE)	TABNAM	CVESO_ESO_S_DRAW	Table Name	20080410
3	GC_OBJECT_TYPE	Constant	Public	☐	Type reference (TYPE)	ESH_E_OM_OBJECT_TYPE	CVESO_ESO_DOCUM_INFO_REC	Object Type: DIR	20080326
4	GC_TABNAM_DRAW	Constant	Public	☐	Type reference (TYPE)	TABNAM	CVESO_DRAW	table: DRAW	20080410
5	GO_GEN_INSTANCE	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CL_ESH_IF_GENERIC_DB_ITERATOR		Extract data from any DB table	20080403
6	GV_INDEXING	Static Attribute	Private	☐	Type reference (TYPE)	XFELD		Checkbox	20080415

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CLASS_CONSTRUCTOR	Static method	Public	Constructor	CLASS_CONSTRUCTOR	20080326
2	DESCRIPTION	Instance method	Private	Method	get texts belonging to current root node	20080410
3	DOCUM_TO_KPRO_ORIG	Instance method	Private	Method	Get something else belonging to current node	20080408
4	FILL_DOCUMENT_KEY_FOR_LAYOUT	Instance method	Private	Method	fill join keys	20090925
5	FILL_JOIN_KEYS	Instance method	Private	Method	fill join keys	20080731
6	GET_ADDITIONAL_DATA	Instance method	Private	Method	get additional data	20080428
7	GET_DATA	Instance method	Private	Method	Get object data by list of object ids	20080403
8	GET_DEPENDING_NODE_DATA	Instance method	Private	Method	get data from further nodes belonging to root node	20080403
9	GET_ROOT_NODE_DATA	Instance method	Private	Method	get a set of data for given root node	20080403
10	NEXT	Instance method	Private	Method	Get next data package by last object id	20080403
11	SET_CHANGEPOINTER	Static method	Public	Method	Write changepionter	20080415
12	STATUS_PROTOCOL	Instance method	Private	Method	get texts belonging to current root node	20080410

Events

Class CL_DOCUMENT_EXTRACT has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	GTY_S_DOC2LOIO	Private	Type reference (TYPE)	DMS_DOC2LOIO		20080418
2	GTY_S_DRAD	Private	Type reference (TYPE)	DRAD		20080403
3	GTY_S_DRAD_KEY	Public	See coding			20080423	BEGIN OF gty_s_drad_key, dokar TYPE dokar, doknr TYPE doknr, dokvr TYPE dokvr, doktl TYPE doktl_d, dokob TYPE dokob, obzae TYPE obzae, objky TYPE objky, END OF gty_s_drad_key
4	GTY_S_DRAP	Private	Type reference (TYPE)	DRAP		20080409
5	GTY_S_DRAP_KEY	Public	See coding			20080423	BEGIN OF gty_s_drap_key, dokar TYPE dokar, doknr TYPE doknr, dokvr TYPE dokvr, doktl TYPE doktl_d, dokst TYPE dokst, stzae TYPE stzae, END OF gty_s_drap_key
6	GTY_S_DRAT	Private	Type reference (TYPE)	DRAT		20080403
7	GTY_S_DRAT_KEY	Public	See coding			20080423	BEGIN OF gty_s_drat_key, dokar TYPE dokar, doknr TYPE doknr, dokvr TYPE dokvr, doktl TYPE doktl_d, langu TYPE cvlang, END OF gty_s_drat_key
8	GTY_S_DRAW	Private	Type reference (TYPE)	DRAW		20080326
9	GTY_S_DRAW_KEY	Public	See coding			20080326	BEGIN OF gty_s_draw_key, dokar TYPE dokar, doknr TYPE doknr, dokvr TYPE dokvr, doktl TYPE doktl_d, END OF gty_s_draw_key
10	GTY_S_ESO_DRAD	Private	Type reference (TYPE)	ESO_S_DRAD		20080407
11	GTY_S_ESO_DRAP	Private	Type reference (TYPE)	ESO_S_DRAP		20080409
12	GTY_S_ESO_DRAT	Private	Type reference (TYPE)	ESO_S_DRAT		20080407
13	GTY_S_ESO_DRAW	Private	Type reference (TYPE)	ESO_S_DRAW		20080407
14	GTY_S_ESO_KPRO	Private	Type reference (TYPE)	DMS_ESO_DOC_TO_KPRO_ORIG		20080408
15	GTY_S_OBJECT	Public	See coding			20080423	begin of gty_s_object, tabname type tabname, updateflag type char1, data type ref to data, end of gty_s_object
16	GTY_S_UPD_DRAD	Public	See coding			20080423	BEGIN OF gty_s_upd_drad, updateflag TYPE char1. INCLUDE TYPE drad as drad. TYPES: END OF gty_s_upd_drad
17	GTY_S_UPD_DRAP	Public	See coding			20080423	BEGIN OF gty_s_upd_drap, updateflag TYPE char1. INCLUDE TYPE drap as drap. TYPES: END OF gty_s_upd_drap
18	GTY_S_UPD_DRAT	Public	See coding			20080423	BEGIN OF gty_s_upd_drat, updateflag TYPE char1. INCLUDE TYPE drat as drat. TYPES: END OF gty_s_upd_drat
19	GTY_S_UPD_DRAW	Public	See coding			20080422	BEGIN OF gty_s_upd_draw, updateflag TYPE char1. INCLUDE TYPE draw as draw. TYPES: END OF gty_s_upd_draw
20	GTY_T_DOC2LOIO	Private	See coding			20080418	gty_t_doc2loio type STANDARD TABLE OF gty_s_doc2loio
21	GTY_T_DRAD	Private	See coding			20080403	gty_t_drad TYPE STANDARD TABLE OF gty_s_drad WITH DEFAULT KEY
22	GTY_T_DRAD_KEY	Public	See coding			20080423	gty_t_drad_key type standard table of gty_s_drad_key
23	GTY_T_DRAP	Private	See coding			20080409	gty_t_drap type standard table of gty_s_drap
24	GTY_T_DRAP_KEY	Public	See coding			20080423	gty_t_drap_key type standard table of gty_s_drap_key
25	GTY_T_DRAT	Private	See coding			20080403	gty_t_drat TYPE STANDARD TABLE OF gty_s_drat WITH DEFAULT KEY
26	GTY_T_DRAT_KEY	Public	See coding			20080423	gty_t_drat_key type standard table of gty_s_drat_key
27	GTY_T_DRAW	Private	See coding			20080326	gty_t_draw TYPE STANDARD TABLE OF gty_s_draw WITH DEFAULT KEY
28	GTY_T_DRAW_KEY	Public	See coding			20080423	gty_t_draw_key type standard table of gty_s_draw_key
29	GTY_T_ESO_DRAD	Private	See coding			20080407	gty_t_eso_drad type standard table of gty_s_eso_drad
30	GTY_T_ESO_DRAP	Private	See coding			20080409	gty_t_eso_drap type standard table of gty_s_eso_drap
31	GTY_T_ESO_DRAT	Private	See coding			20080407	gty_t_eso_drat type standard table of gty_s_eso_drat
32	GTY_T_ESO_DRAW	Private	See coding			20080407	gty_t_eso_draw type standard table of gty_s_eso_draw
33	GTY_T_ESO_KPRO	Private	See coding			20080408	gty_t_eso_kpro type standard table of gty_s_eso_kpro
34	GTY_T_OBJECTS	Public	See coding			20080423	gty_t_objects type standard table of gty_s_object

Method Signatures

Method CLASS_CONSTRUCTOR Signature

Method CLASS_CONSTRUCTOR on class CL_DOCUMENT_EXTRACT has no parameter.
Method CLASS_CONSTRUCTOR on class CL_DOCUMENT_EXTRACT has no exception.

Method DESCRIPTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_OBJECT_EXTRACTION	Call by reference	☐	Type reference (TYPE)	ESH_S_IF_EXTRACT_NODE		Extraction of one node	20080410
2	Importing	IT_DRAW_KEY	Call by reference	☐	Type reference (TYPE)	GTY_T_DRAW_KEY			20080421

Method DESCRIPTION on class CL_DOCUMENT_EXTRACT has no exception.

Method DOCUM_TO_KPRO_ORIG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_OBJECT_EXTRACTION	Call by reference	☐	Type reference (TYPE)	ESH_S_IF_EXTRACT_NODE		Extraction of one node	20080408
2	Importing	IT_DRAW_KEY	Call by reference	☐	Type reference (TYPE)	GTY_T_DRAW_KEY			20080421

Method DOCUM_TO_KPRO_ORIG on class CL_DOCUMENT_EXTRACT has no exception.

Method FILL_DOCUMENT_KEY_FOR_LAYOUT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CS_ROOT_NODE_DATA	Call by reference	☐	Type reference (TYPE)	ANY			20090925
2	Importing	IS_DRAW_KEY	Call by reference	☐	Type reference (TYPE)	GTY_S_DRAW_KEY			20090925

Method FILL_DOCUMENT_KEY_FOR_LAYOUT on class CL_DOCUMENT_EXTRACT has no exception.

Method FILL_JOIN_KEYS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CS_ROOT_NODE_DATA	Call by reference	☐	Type reference (TYPE)	ANY			20080731
2	Importing	IS_DRAW_KEY	Call by reference	☐	Type reference (TYPE)	GTY_S_DRAW_KEY			20080731

Method FILL_JOIN_KEYS on class CL_DOCUMENT_EXTRACT has no exception.

Method GET_ADDITIONAL_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_OBJECT_EXTRACTION	Call by reference	☐	Type reference (TYPE)	ESH_S_IF_EXTRACT_NODE		Extraction of one node	20080428
2	Importing	IT_DRAW_KEY	Call by reference	☐	Type reference (TYPE)	GTY_T_DRAW_KEY			20080428

Method GET_ADDITIONAL_DATA on class CL_DOCUMENT_EXTRACT has no exception.

Method GET_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_MESSAGES	Call by reference	☐	Type reference (TYPE)	BAPIRETTAB		Table with BAPI Return Information	20080403
2	Importing	IT_OBJECT_EXTRACTION	Call by reference	☐	Type reference (TYPE)	ESH_T_IF_EXTRACT_NODES		Extraction of nodes	20080403
3	Importing	IT_OBJECT_IDS	Call by reference	☐	Type reference (TYPE)	ESH_T_IF_CHANGED_OBJECTS		Changed Objects	20080403
4	Importing	IV_OBJECT_TYPE_BACKEND_NAME	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_BACKEND_NAME		Backend Name	20080403
5	Importing	IV_OBJECT_TYPE_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_OBJECT_TYPE		Object Type	20080403

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_PROVIDER_ERROR	☐	General error in provider	20080403

Method GET_DEPENDING_NODE_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_MESSAGES	Call by reference	☐	Type reference (TYPE)	BAPIRETTAB		Table with BAPI Return Information	20080416
2	Importing	IS_OBJECT_EXTRACTION	Call by reference	☐	Type reference (TYPE)	ESH_S_IF_EXTRACT_NODE		Extraction of nodes	20080403
3	Importing	IT_DRAW_KEY	Call by reference	☐	Type reference (TYPE)	GTY_T_DRAW_KEY			20080421

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_PROVIDER_ERROR	☐	General error in provider	20080416

Method GET_ROOT_NODE_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_MESSAGES	Call by reference	☐	Type reference (TYPE)	BAPIRETTAB		Table with BAPI Return Information	20080403
2	Exporting	EV_LAST_OBJECT_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_GENERAL_ID		General ID	20080403
3	Exporting	EV_NO_MORE_DATA	Call by reference	☐	Type reference (TYPE)	XFELD		Checkbox	20080403
4	Importing	IS_OBJECT_EXTRACTION	Call by reference	☐	Type reference (TYPE)	ESH_S_IF_EXTRACT_NODE		Extraction of one node	20080403
5	Importing	IV_LAST_OBJECT_ID	Call by reference	☑	Type reference (TYPE)	ESH_E_IF_GENERAL_ID		General ID	20080403
6	Importing	IV_PACKAGE_SIZE	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_PACKAGE_SIZE		Package size	20080403

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_PROVIDER_ERROR	☐	General error in provider	20080403

Method NEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_MESSAGES	Call by reference	☐	Type reference (TYPE)	BAPIRETTAB		Table with BAPI Return Information	20080403
2	Exporting	EV_LAST_OBJECT_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_GENERAL_ID		General ID	20080403
3	Exporting	EV_NO_MORE_DATA	Call by reference	☐	Type reference (TYPE)	XFELD		Checkbox	20080403
4	Importing	IT_OBJECT_EXTRACTION	Call by reference	☐	Type reference (TYPE)	ESH_T_IF_EXTRACT_NODES		Extraction of nodes	20080403
5	Importing	IV_LAST_OBJECT_ID	Call by reference	☑	Type reference (TYPE)	ESH_E_IF_GENERAL_ID		General ID	20080403
6	Importing	IV_OBJECT_TYPE_BACKEND_NAME	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_BACKEND_NAME		Backend Name	20080403
7	Importing	IV_OBJECT_TYPE_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_OBJECT_TYPE		Object Type	20080403
8	Importing	IV_PACKAGE_SIZE	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_PACKAGE_SIZE		Package size	20080403

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_PROVIDER_ERROR	☐	General error in provider	20080403

Method SET_CHANGEPOINTER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_OBJECTS	Call by reference	☐	Type reference (TYPE)	GTY_T_OBJECTS			20080423

Method SET_CHANGEPOINTER on class CL_DOCUMENT_EXTRACT has no exception.

Method STATUS_PROTOCOL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_OBJECT_EXTRACTION	Call by reference	☐	Type reference (TYPE)	ESH_S_IF_EXTRACT_NODE		Extraction of one node	20080410
2	Importing	IT_DRAW_KEY	Call by reference	☐	Type reference (TYPE)	GTY_T_DRAW_KEY			20080421

Method STATUS_PROTOCOL on class CL_DOCUMENT_EXTRACT has no exception.

History

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