SAP ABAP Class CL_OFFICE_DOC (BusinessDocumentSet)

Hierarchy

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

Properties

Class	CL_OFFICE_DOC
Short Description	BusinessDocumentSet
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

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

Forward declarations

#	Type group / Object type	Type	Type Description
1	SBDST	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
2	SOI	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_OFFICE_DOC has no interface implemented.

Friends

Class CL_OFFICE_DOC has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_BDS_CLASSNAME_TASK	Constant	Public	☐	Type reference (TYPE)	SBDST_CLASSNAME	'SCHEDMAN_TASK'		20050321
2	GC_BDS_CLASSTYPE	Constant	Public	☐	Type reference (TYPE)	SBDST_CLASSTYPE	'OT'		20050321
3	M_BUFFER_DOC_ID	Static Attribute	Public	☐	Type reference (TYPE)	TFC_T_DOC_BUFFER		Buffer f. Office Documents	20050321

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	BUFFER_OFFICE_KEYS	Static method	Public	Method	Buffer Office Documents	20050321
2	COPY_DOCUMENT	Static method	Public	Method	Copy a Document	20050321
3	GET_OFFICE_DOCUMENTS	Static method	Public	Method	Read Office Documents	20050321
4	OFFICE_DOCUMENT_EXISTS	Static method	Public	Method	OFFICE_DOCUMENT_EXISTS	20050321
5	OFFICE_DOCUMENT_PROCESS	Static method	Public	Method	Select, Create Office Document	20050321

Events

Class CL_OFFICE_DOC has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	T_OI_RET_STRING	Private	Type reference (TYPE)	SOI_CONTROL_PARAM_TYPE		20050321

Method Signatures

Method BUFFER_OFFICE_KEYS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	P_CITEM	Call by reference	☐	Object reference (TYPE REF TO)	CITEMX		Knotenelement	20050321
2	Importing	P_DOC_ID	Call by reference	☐	Type reference (TYPE)	BDS_DOCID		Business Document Service: Dokument-ID	20050321
3	Importing	P_MODE	Call by reference	☐	Type reference (TYPE)	CHAR1		'I': Create, 'U': Update	20050321

#	Exception	Resumable	Description	Created on
1	MODE_NOT_SUPPORTED	☐		20050321

Method COPY_DOCUMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ED_DOCUMENT_ID_NEW	Call by reference	☐	Type reference (TYPE)	BDS_DOCID		Business Document Service: Dokument-ID	20050321
2	Importing	ID_CLIENT_FROM	Call by reference	☐	Type reference (TYPE)	SYMANDT	SY-MANDT	R/3-System, Mandantennummer aus Anmeldung	20050321
3	Importing	ID_CLIENT_TO	Call by reference	☐	Type reference (TYPE)	SYMANDT	SY-MANDT	R/3-System, Mandantennummer aus Anmeldung	20050321
4	Importing	ID_DOCUMENT_CLASS	Call by reference	☐	Type reference (TYPE)	SBDST_CLASSNAME	GC_BDS_CLASSNAME_TASK		20050321
5	Importing	ID_DOCUMENT_ID	Call by reference	☐	Type reference (TYPE)	BDS_DOCID			20050321

#	Exception	Resumable	Description	Created on
1	FUNCTION_CANCELLED	☐	Funktion wurde vom Anwender abgebrochen	20050321
2	OFFICE_INTEGRATION_ERROR	☐	Fehler in der Office-Integration	20050321

Method GET_OFFICE_DOCUMENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	DOCUMENTS	Call by reference	☐	Type reference (TYPE)	TFC_T_DOC_BUFFER2		Itab zu TFC_S_DOC_BUFFER2	20050321
2	Importing	ID_STATUS_FROM_DB	Call by reference	☐	Type reference (TYPE)	CHAR1	' '	Info aus der DB holen?	20090714
3	Importing	PCITEM	Call by reference	☐	Object reference (TYPE REF TO)	CITEMX		Knotenelement	20050321
4	Importing	PINSTANCE	Call by reference	☐	Type reference (TYPE)	TFC_NUM		Zähler	20050321
5	Importing	PPROFILE	Call by reference	☐	Type reference (TYPE)	TFC_PROFILE		FastClose: Abschlußplan	20050321

#	Exception	Resumable	Description	Created on
1	NOT_AUTHORIZED	☐	keine Berechtigung	20050321
2	NO_OFFICE_DOCUMENT	☐		20050321
3	OFFICE_INTEGRATION_ERROR	☐	Fehler aus der Integration	20050321

Method OFFICE_DOCUMENT_EXISTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ID_DOCUMENT_CLASS	Call by reference	☐	Type reference (TYPE)	SBDST_CLASSNAME			20050321
2	Importing	ID_DOCUMENT_ID	Call by reference	☐	Type reference (TYPE)	BDS_DOCID		Business Document Service: Dokument-ID	20050321

#	Exception	Resumable	Description	Created on
1	NOT_AUTHORIZED	☐	Keine Berechtigung	20050321
2	NOT_FOUND	☐	Funktion wurde vom Anwender abgebrochen	20050321
3	OFFICE_INTEGRATION_ERROR	☐	Fehler aus der Integration	20050321

Method OFFICE_DOCUMENT_PROCESS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ED_DOCUMENT_ID_NEW	Call by reference	☐	Type reference (TYPE)	BDS_DOCID		chlüssel des angelegten BDS-Dokuments (Ausg.)	20050321
2	Importing	IB_NO_CONFIRMATION	Call by reference	☐	Type reference (TYPE)	CHAR1	' '	Keine Sicherheitsabfrage beim Löschen	20050321
3	Importing	ID_APPLICATION_NAME	Call by reference	☐	Type reference (TYPE)	ITEX132		Überschrift der Office-Anwendung	20050321
4	Importing	ID_DOCUMENT_ID	Call by reference	☐	Type reference (TYPE)	BDS_DOCID		Schlüssel des BDS-Dokuments (Eingang)	20050321
5	Importing	ID_PROCESSING_MODE	Call by reference	☐	Type reference (TYPE)	CHAR1		Anlegen(I), Ändern(C), Anzeigen(D), Löschen(E)	20050321
6	Importing	ID_RECONFIRM_FUNCNAME	Call by reference	☐	Type reference (TYPE)	RS38L_FNAM	''	Name des Funktionsbausteins	20050321

#	Exception	Resumable	Description	Created on
1	FUNCTION_CANCELLED	☐	Funktion wurde vom Anwender abgebrochen	20050321
2	NOTHING_FOUND	☐	Dokument wurde nicht gefunden	20050321
3	NOT_AUTHORIZED	☐	keine Berechtigung für Office-Integration	20050321
4	OFFICE_INTEGRATION_ERROR	☐	Fehler in der Office-Integration	20050321

History

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