SAP ABAP Class CL_DOCU_HANDLER (Document Processing: Closing Cockpit)

Hierarchy

☛ EA-FIN (Software Component) EA-FIN
   ⤷ AC (Application Component) Accounting - General
     ⤷ FB_CLOSING (Package) Closing

Properties

Class	CL_DOCU_HANDLER
Short Description	Document Processing: Closing Cockpit
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class	TFC0
Program status
Category	0
Package	FB_CLOSING	Closing
Created	20100824	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	VRM	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_DOCU_HANDLER has no interface implemented.

Friends

Class CL_DOCU_HANDLER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CMD_CLASSNAME	Constant	Public	☐	Type reference (TYPE)	BDS_CLSNAM	'SCHEDMAN_TASK'	Business Document Service: Class Name	20101101
2	CMD_CLASSTYPE	Constant	Public	☐	Type reference (TYPE)	BDS_CLSTYP	'OT'	Business Document Service: Class Type	20101101
3	CMD_DOCU_DELETE	Constant	Public	☐	Type reference (TYPE)	C	'D'		20101019
4	CMD_DOCU_EXCEL	Constant	Public	☐	Type reference (TYPE)	STRING	'Excel.Sheet.12'	Excel Document	20100914
5	CMD_DOCU_EXCEL_2003	Constant	Public	☐	Type reference (TYPE)	STRING	'Excel.Sheet.8'	Excel Document	20100914
6	CMD_DOCU_EXCEL_CHART_2003	Constant	Public	☐	Type reference (TYPE)	STRING	'Excel.Chart.8'	Excel Graph	20101008
7	CMD_DOCU_EXT_EXCEL	Constant	Public	☐	Type reference (TYPE)	STRING	'XLSX'	Excel Document	20101006
8	CMD_DOCU_EXT_EXCEL_2003	Constant	Public	☐	Type reference (TYPE)	STRING	'XLS'	Excel Document	20101006
9	CMD_DOCU_EXT_EXCEL_CHART_2003	Constant	Public	☐	Type reference (TYPE)	STRING	'XLC'	Excel Graph	20101008
10	CMD_DOCU_EXT_LINK	Constant	Public	☐	Type reference (TYPE)	STRING	'URL'	URL Link	20101006
11	CMD_DOCU_EXT_PDF	Constant	Public	☐	Type reference (TYPE)	STRING	'PDF'	PDF Document	20101006
12	CMD_DOCU_EXT_POWERPOINT	Constant	Public	☐	Type reference (TYPE)	STRING	'PPTX'	PowerPoint Document	20101006
13	CMD_DOCU_EXT_POWERPOINT_2003	Constant	Public	☐	Type reference (TYPE)	STRING	'PPT'	PowerPoint Document	20101006
14	CMD_DOCU_EXT_TEXT	Constant	Public	☐	Type reference (TYPE)	STRING	'TXT'	Document Text	20101006
15	CMD_DOCU_EXT_WORD	Constant	Public	☐	Type reference (TYPE)	STRING	'DOCX'	Word Document	20101006
16	CMD_DOCU_EXT_WORD_2003	Constant	Public	☐	Type reference (TYPE)	STRING	'DOC'	Word Document	20101006
17	CMD_DOCU_INSERT	Constant	Public	☐	Type reference (TYPE)	C	'I'		20101019
18	CMD_DOCU_LINK	Constant	Public	☐	Type reference (TYPE)	STRING	'URL'	URL Link	20100921
19	CMD_DOCU_PDF	Constant	Public	☐	Type reference (TYPE)	STRING	'PDF'	PDF Document	20100914
20	CMD_DOCU_POWERPOINT_SHOW	Constant	Public	☐	Type reference (TYPE)	STRING	'PowerPoint.Show.12'	PowerPoint Document	20100914
21	CMD_DOCU_POWERPOINT_SHOW_2003	Constant	Public	☐	Type reference (TYPE)	STRING	'PowerPoint.Show.8'	PowerPoint Document	20100914
22	CMD_DOCU_POWERPOINT_SLIDE	Constant	Public	☐	Type reference (TYPE)	STRING	'PowerPoint.Slide.12'	PowerPoint Document	20100914
23	CMD_DOCU_POWERPOINT_SLIDE_2003	Constant	Public	☐	Type reference (TYPE)	STRING	'PowerPoint.Slide.8'	PowerPoint Document	20100914
24	CMD_DOCU_TEXT	Constant	Public	☐	Type reference (TYPE)	STRING	'TXT'	Document Text	20100914
25	CMD_DOCU_UPDATE	Constant	Public	☐	Type reference (TYPE)	C	'U'		20101019
26	CMD_DOCU_WORD	Constant	Public	☐	Type reference (TYPE)	STRING	'Word.Document.12'	Word Document	20100914
27	CMD_DOCU_WORD_2003	Constant	Public	☐	Type reference (TYPE)	STRING	'Word.Document.8'	Word Document 2003	20100914

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CREATE_DOCU	Static method	Public	Method	Create Document	20100824
2	CREATE_IMPORT_DOCU	Static method	Public	Method	Import Document Again (Replace)	20101026
3	DELETE_DOCU	Static method	Public	Method	Delete Document	20100824
4	DISPLAY_INTEGRATION_MESSAGES	Static method	Public	Method	display_integration_messages	20101027
5	DOCU_AUTH_CHECK	Static method	Public	Method		20101019
6	DOC_DATA_MODIFY_DIRECT	Static method	Public	Method	Store TFC_INST_OFFICE Data	20101019
7	GET_BDS_FILE_SIZE	Static method	Public	Method	GET_BDS_FILE_SIZE	20101004
8	GET_DOCU_EXTENSION	Static method	Public	Method	GET_DOCU_EXTENSION	20100824
9	GET_DOCU_EXTENSION_FROM_FNAME	Static method	Public	Method	GET_DOCU_EXTENSION_FROM_FNAME	20100922
10	GET_DOCU_EXTENSION_NO_COMMA	Static method	Public	Method	GET_DOCU_EXTENSION_NO_COMMA	20100921
11	GET_DOCU_LIST_CREA	Static method	Public	Method	GET_DOCU_LIST_CREA	20100914
12	GET_DOCU_MIMETYPE	Static method	Public	Method	GET_DOCU_MIMETYPE	20100916
13	GET_DOCU_MIMETYPE_DESCR	Static method	Public	Method	GET_DOCU_MIMETYPE_DESCR	20101005
14	GET_DOCU_TYPE	Static method	Public	Method	GET_DOCU_TYPE	20100824
15	IMPORT_DOCU	Static method	Public	Method	Import Document	20100824
16	IS_SUPPORTED_EXTENSION	Static method	Public	Method	IS_SUPPORTED_EXTENSION	20100915
17	LOAD_ITEM_DOCUMENTS	Static method	Public	Method	LOAD_ITEM_DOCUMENTS	20101005
18	MODIFY_DOCU	Static method	Public	Method	Change Document	20100824
19	REIMPORT_DOCU	Static method	Public	Method	Import Document Again (Replace)	20101014
20	UPDATE_DOC_DATA	Static method	Public	Method	UPDATE_DOC_DATA	20101022
21	VIEW_DOCU	Static method	Public	Method	Display Document	20100824

Events

Class CL_DOCU_HANDLER has no event.

Types

Class CL_DOCU_HANDLER has no local type.

Method Signatures

Method CREATE_DOCU Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ED_ACTION_CANCELLED	Call by reference	☐	Type reference (TYPE)	CHAR1		Einstelliges Kennzeichen	20101015
2	Exporting	ED_BDS_DOCID	Call by reference	☐	Type reference (TYPE)	BDS_DOCID		Business Document Service: Dokument-ID	20100906
3	Importing	ID_DOCUMENT_TYPE	Call by reference	☑	Type reference (TYPE)	CHAR80		Char 80	20100908
4	Importing	IR_GRID	Call by reference	☐	Object reference (TYPE REF TO)	CL_DOCU_GRID		Darstellung Item-Dokumente	20101022

Method CREATE_DOCU on class CL_DOCU_HANDLER has no exception.

Method CREATE_IMPORT_DOCU Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ID_DATA	Call by reference	☑	Type reference (TYPE)	XSTRING			20101026
2	Importing	ID_DOCUMENT_TYPE	Call by reference	☑	Type reference (TYPE)	STRING			20101026
3	Importing	ID_DOC_DESCR	Call by reference	☐	Type reference (TYPE)	TFC_DOC_DESCR		Titel des Dokuments	20101026
4	Importing	ID_FILENAME	Call by reference	☑	Type reference (TYPE)	STRING			20101026
5	Importing	ID_LINK_URL	Call by reference	☑	Type reference (TYPE)	STRING			20101026
6	Importing	IR_GRID	Call by reference	☑	Object reference (TYPE REF TO)	CL_DOCU_GRID		Darstellung Item-Dokumente	20101026
7	Importing	IR_ITEM	Call by reference	☐	Object reference (TYPE REF TO)	CITEMX		Knotenelement	20101026

#	Exception	Resumable	Description	Created on
1	UNSUPPORTED_DOCU_EXTENSION	☐	Typ des Dokuments ist nicht unterstützt	20101101

Method DELETE_DOCU Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ID_BDS_DOCID	Call by reference	☐	Type reference (TYPE)	BDS_DOCID		Business Document Service: Dokument-ID	20100826
2	Importing	IR_ITEM	Call by reference	☐	Object reference (TYPE REF TO)	CITEMX		Knotenelement	20101101

#	Exception	Resumable	Description	Created on
1	NOT_AUTHORIZED	☐	Keine Berechtigungen	20100906

Method DISPLAY_INTEGRATION_MESSAGES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ID_SUBRC	Value transfer	☐	Type reference (TYPE)	INT4		Rückgabewert von ABAP-Anweisungen	20101027

Method DISPLAY_INTEGRATION_MESSAGES on class CL_DOCU_HANDLER has no exception.

Method DOCU_AUTH_CHECK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ID_PROFILE	Call by reference	☐	Type reference (TYPE)	TFC_PROFILE		FastClose: Abschlußplan	20101019
2	Returning	RD_SUBRC	Value transfer	☐	Attribute reference (LIKE)	SY-SUBRC		Rückgabewert von ABAP-Anweisungen	20101019

Method DOCU_AUTH_CHECK on class CL_DOCU_HANDLER has no exception.

Method DOC_DATA_MODIFY_DIRECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ID_OP	Call by reference	☐	Type reference (TYPE)	C			20101019
2	Importing	IS_DOCUMENT	Call by reference	☐	Type reference (TYPE)	TFC_INST_OFFICE		Office-Dokumente	20101019

Method DOC_DATA_MODIFY_DIRECT on class CL_DOCU_HANDLER has no exception.

Method GET_BDS_FILE_SIZE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ED_FILE_SIZE	Call by reference	☐	Type reference (TYPE)	TFC_FSIZE		Dateigröße	20101004
2	Importing	ID_BDS_DOCID	Call by reference	☐	Type reference (TYPE)	BDS_DOCID		Business Document Service: Dokument-ID	20101004

Method GET_BDS_FILE_SIZE on class CL_DOCU_HANDLER has no exception.

Method GET_DOCU_EXTENSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ID_DOCU_TYPE	Call by reference	☐	Type reference (TYPE)	CHAR80		Character 40-Stellen	20100824
2	Returning	RD_EXTENSION	Value transfer	☐	Type reference (TYPE)	STRING			20100824

Method GET_DOCU_EXTENSION on class CL_DOCU_HANDLER has no exception.

Method GET_DOCU_EXTENSION_FROM_FNAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ED_EXTENSION	Call by reference	☐	Type reference (TYPE)	TFC_FILE_TYPE		Dateityp	20100922
2	Importing	ID_FNAME	Call by reference	☐	Type reference (TYPE)	STRING		Dateiname	20100922

Method GET_DOCU_EXTENSION_FROM_FNAME on class CL_DOCU_HANDLER has no exception.

Method GET_DOCU_EXTENSION_NO_COMMA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ID_DOCU_TYPE	Call by reference	☐	Type reference (TYPE)	CHAR80		Char 80	20100921
2	Returning	RD_EXTENSION	Value transfer	☐	Type reference (TYPE)	STRING			20100921

Method GET_DOCU_EXTENSION_NO_COMMA on class CL_DOCU_HANDLER has no exception.

Method GET_DOCU_LIST_CREA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_VRM_VALUES	Call by reference	☐	Type reference (TYPE)	VRM_VALUES			20100914

Method GET_DOCU_LIST_CREA on class CL_DOCU_HANDLER has no exception.

Method GET_DOCU_MIMETYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ED_MIMETYPE	Call by reference	☐	Type reference (TYPE)	W3CONTTYPE		HTML-Content-Type	20100916
2	Importing	ID_FILENAME	Call by reference	☐	Type reference (TYPE)	STRING		Umsetztabelle von internen Dateinamen in externe Dateinamen	20100916

#	Exception	Resumable	Description	Created on
1	UNSUPPORTED_DOCU_EXTENSION	☐	Nicht unterstützt datei Format	20100916

Method GET_DOCU_MIMETYPE_DESCR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ED_DESCRIPTION	Call by reference	☐	Type reference (TYPE)	TEXT60		Textfeld der Länge 60	20101005
2	Importing	ID_FILENAME	Call by reference	☐	Type reference (TYPE)	STRING		Umsetztabelle von internen Dateinamen in externe Dateinamen	20101005

Method GET_DOCU_MIMETYPE_DESCR on class CL_DOCU_HANDLER has no exception.

Method GET_DOCU_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ED_DOCU_TYPE	Call by reference	☐	Type reference (TYPE)	CHAR80		Char 80	20100824
2	Importing	ID_FILENAME	Call by reference	☐	Type reference (TYPE)	STRING		Umsetztabelle von internen Dateinamen in externe Dateinamen	20100824

#	Exception	Resumable	Description	Created on
1	UNSUPPORTED_DOCU_EXTENSION	☐	Nicht unterstützt datei Format	20100824

Method IMPORT_DOCU Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ED_BDS_DOCID	Call by reference	☐	Type reference (TYPE)	BDS_DOCID		Business Document Service: Dokument-ID	20100826
2	Importing	ID_DATA	Call by reference	☑	Type reference (TYPE)	XSTRING			20101026
3	Importing	ID_FILENAME	Call by reference	☑	Type reference (TYPE)	STRING		Business Document Service: Dateinamen	20101026

Method IMPORT_DOCU on class CL_DOCU_HANDLER has no exception.

Method IS_SUPPORTED_EXTENSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ID_FILENAME	Call by reference	☐	Type reference (TYPE)	STRING		Char 80	20100915
2	Returning	RD_IS_SUPPORTED	Value transfer	☐	Type reference (TYPE)	CHAR1		Einstelliges Kennzeichen	20100915

Method IS_SUPPORTED_EXTENSION on class CL_DOCU_HANDLER has no exception.

Method LOAD_ITEM_DOCUMENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_DOCUMENTS	Call by reference	☐	Type reference (TYPE)	TFC_T_OFFICE_DOCUMENTS		Tabellentyp des Office Dokumente Dateien	20101005
2	Importing	IR_ITEM	Call by reference	☐	Object reference (TYPE REF TO)	CITEMX		Knotenelement	20101005

Method LOAD_ITEM_DOCUMENTS on class CL_DOCU_HANDLER has no exception.

Method MODIFY_DOCU Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ED_BDS_DOCID	Call by reference	☐	Type reference (TYPE)	BDS_DOCID		Business Document Service: Dokument-ID	20100906
2	Importing	ID_BDS_DOCID	Call by reference	☐	Type reference (TYPE)	BDS_DOCID		Business Document Service: Dokument-ID	20100906
3	Importing	ID_EXTENSION	Call by reference	☑	Type reference (TYPE)	TFC_FILE_TYPE			20100909
4	Importing	IR_GRID	Call by reference	☐	Object reference (TYPE REF TO)	CL_DOCU_GRID		Knotenelement	20101022
5	Importing	IR_ITEM	Call by reference	☐	Object reference (TYPE REF TO)	CITEMX		Knotenelement	20110328

Method MODIFY_DOCU on class CL_DOCU_HANDLER has no exception.

Method REIMPORT_DOCU Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ID_BDS_DOCID	Call by reference	☐	Type reference (TYPE)	BDS_DOCID		Business Document Service: Dokument-ID	20101014
2	Importing	ID_DATA	Call by reference	☑	Type reference (TYPE)	XSTRING			20101018
3	Importing	ID_FILENAME	Call by reference	☐	Type reference (TYPE)	STRING		Dateiname	20101026
4	Importing	IR_ITEM	Call by reference	☐	Object reference (TYPE REF TO)	CITEMX		Knotenelement	20101018

#	Exception	Resumable	Description	Created on
1	UNSUPPORTED_DOCU_EXTENSION	☐	Typ des Dokuments ist nicht unterstützt	20101101

Method UPDATE_DOC_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ID_BDS_DOCID	Call by reference	☐	Type reference (TYPE)	BDS_DOCID		Business Document Service: Dokument-ID	20101022
2	Importing	ID_DOCU_TYPE	Call by reference	☑	Type reference (TYPE)	TFC_FILE_TYPE		Dateityp	20101022
3	Importing	ID_DOC_COMMENT	Call by reference	☑	Type reference (TYPE)	TFC_DOC_COMMENT		Kommentar	20110118
4	Importing	ID_DOC_DESCR	Call by reference	☑	Type reference (TYPE)	TFC_DOC_DESCR		Titel des Dokuments	20110118
5	Importing	ID_LANG	Call by reference	☑	Type reference (TYPE)	SPRAS		Sprachenschlüssel	20110118
6	Importing	ID_LINK_URL	Call by reference	☑	Type reference (TYPE)	TFC_LINK_URL		Link	20110118
7	Importing	IR_ITEM	Call by reference	☐	Object reference (TYPE REF TO)	CITEMX		Knotenelement	20101022

Method UPDATE_DOC_DATA on class CL_DOCU_HANDLER has no exception.

Method VIEW_DOCU Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ID_BDS_DOCID	Call by reference	☐	Type reference (TYPE)	BDS_DOCID		Business Document Service: Dokument-ID	20100826
2	Importing	ID_EXTENSION	Call by reference	☐	Type reference (TYPE)	STRING			20100907
3	Importing	ID_LINK_URL	Call by reference	☐	Type reference (TYPE)	TFC_LINK_URL		Link	20100917

Method VIEW_DOCU on class CL_DOCU_HANDLER has no exception.

History

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