SAP ABAP Class CL_SEM_MP_DOC_APPL (Class for Documents in Manual Planning)

Hierarchy

☛ SAP_BW (Software Component) SAP Business Warehouse
   ⤷ BW-PLA-BPS (Application Component) Business Planning and Simulation
     ⤷ UPP (Package) SEM-BPS: Planning Processor and Layout Builder

Properties

Class	CL_SEM_MP_DOC_APPL
Short Description	Class for Documents in Manual Planning
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class	UPP_DOC
Program status
Category	0
Package	UPP	SEM-BPS: Planning Processor and Layout Builder
Created	20010626	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	SOI	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_SEM_MP_DOC_APPL has no interface implemented.

Friends

Class CL_SEM_MP_DOC_APPL has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	AREA	Instance attribute	Private	☐	Type reference (TYPE)	UPC_Y_AREA			20010629
2	C_DOC_SOURCE	Constant	Private	☐	Type reference (TYPE)	UPC_Y_DOC_SOURCE	'D'		20010629
3	C_DOC_TYPE_TEXT	Constant	Private	☐	Type reference (TYPE)	CHAR4	SOI_DOCFORMAT_TEXT		20010629
4	C_INIT_VALUE	Constant	Private	☐	Type reference (TYPE)	CHAR1	'#'		20010629
5	C_OK_CLOSE_DOC	Constant	Public	☐	Type reference (TYPE)	UI_FUNC	'DOC_CLOSE'	Function Code	20010706
6	C_TODO_DELETE	Constant	Private	☐	Type reference (TYPE)	UPC_Y_TODO	'D'		20010629
7	C_TODO_INSERT	Constant	Private	☐	Type reference (TYPE)	UPC_Y_TODO	'I'		20010629
8	C_TODO_UPDATE	Constant	Private	☐	Type reference (TYPE)	UPC_Y_TODO	'U'		20010629
9	HNDL_LEVEL	Instance attribute	Private	☐	Type reference (TYPE)	UPP_Y_HNDL_LEVEL			20010629
10	LEVEL	Instance attribute	Private	☐	Type reference (TYPE)	UPC_Y_PLEVEL			20010629
11	OPEN_DOC_READ_ONLY	Instance attribute	Private	☐	Type reference (TYPE)	CHAR1		Single-Character Flag	20040805
12	READ_ONLY	Instance attribute	Private	☐	Type reference (TYPE)	CHAR1			20010629
13	RETCODE	Instance attribute	Private	☐	Type reference (TYPE)	SOI_RET_STRING			20010629
14	R_AREA_ATTR	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_SEM_PLANAREA_ATTRIBUTES			20010629
15	R_CONTAINER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_GUI_CONTAINER		Container for Custom Controls in the Screen Area	20010629
16	R_CONTROL	Instance attribute	Private	☐	Object reference (TYPE REF TO)	I_OI_OLE_CONTAINER_CONTROL		Document Container Control Interface	20010629
17	R_DOCUMENT	Instance attribute	Private	☐	Object reference (TYPE REF TO)	I_OI_DOCUMENT_PROXY			20010629
18	R_MP_DOCUMENTS	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_SEM_MP_DOCUMENTS			20010629
19	S_OPEN_DOC	Instance attribute	Private	☐	Type reference (TYPE)	UPC_YS_DOC			20010629
20	TO_CHASEL	Instance attribute	Private	☐	Type reference (TYPE)	UPC_YTO_CHASEL			20010629
21	TO_CHA_COM	Instance attribute	Private	☐	Type reference (TYPE)	UPC_YTO_CHA			20010629
22	TO_DOC	Instance attribute	Private	☐	Type reference (TYPE)	UPC_YTO_DOC			20010629
23	TO_DOC_SEL	Instance attribute	Private	☐	Object reference (TYPE REF TO)	DATA			20010629
24	T_DESCR_LIST	Instance attribute	Private	☐	Type reference (TYPE)	UPP_YT_DOC_TYPE_LIST		List of Registered Document Types with Mime Type	20010629

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CLOSE	Instance method	Private	Method	Closes All Open Containers and Documents	20010626
2	CLOSE_EVENT_HANDLER	Instance method	Private	Event handling method	Catches Close Event of Document	20010627
3	COMMIT	Instance method	Public	Method	Reads the Last Document and Writes in Buffer	20010626
4	CONSTRUCTOR	Instance method	Public	Constructor	Generates Object and Executes "INIT"	20010626
5	CONVERT_DOC_SEL	Instance method	Private	Method	Deletes Not Commentable Characteristic Values from doc_sel	20010720
6	CREATE_DOCUMENT	Instance method	Public	Method	Generates a Document	20010626
7	DELETE_DOCUMENT	Instance method	Public	Method	Sets Indicator for Deletion	20010626
8	FILL_CHAVL_INT	Instance method	Private	Method	Fills Chavl Table in Internal Format (# for Initial)	20010627
9	GET_CONTROL_CONTAINER	Instance method	Private	Method	Gets Control Container	20010626
10	GET_DESCR_LIST	Instance method	Private	Method	Gets List of Installed Programs	20010626
11	GET_DOC_FLAG	Instance method	Public	Method	Checks Existence of Doc. to a Selection (Typename_s_doc)	20010626
12	GET_DOC_FROM_IDS	Instance method	Private	Method	Delivers Documents to Doc IDs	20010626
13	GET_DOC_IDS	Instance method	Private	Method	Delivers Doc Id's to a Selection	20010626
14	GET_NO_EXCEL_DOCS	Static method	Private	Method	Excel Documents Switched On?	20040329
15	OPEN_DOCUMENT	Instance method	Public	Method	Opens a Document	20010626
16	OPEN_DOCUMENT_AS_P	Instance method	Private	Method	Internal Method to Open and Generate Docs	20011012
17	OPEN_DOCUMENT_P	Instance method	Private	Method	Internal Method to Open and Generate Docs	20010626
18	READ_DOCUMENT	Instance method	Private	Method	Delivers the Document and Puts it in to_doc	20010626
19	SAVE	Instance method	Public	Method	Saves the Buffer	20010626

Events

#	Event	Type	Visibility	Description	Created on
1	NEW_OK_CODE	Instance Event (0)	Public (2)		20010706

Types

Class CL_SEM_MP_DOC_APPL has no local type.

Method Signatures

Method CLOSE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CLOSE_CONTROL	Call by reference	☑	Type reference (TYPE)	CHAR1	' '	Flag zum Löschen des Containers	20010718

Method CLOSE on class CL_SEM_MP_DOC_APPL has no exception.

Method CLOSE_EVENT_HANDLER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DOCUMENT_PROXY	Value transfer	☐	Attribute reference (LIKE)				20010627
2	Importing	HAS_CHANGED	Value transfer	☐	Attribute reference (LIKE)				20010627

Method CLOSE_EVENT_HANDLER on class CL_SEM_MP_DOC_APPL has no exception.

Method COMMIT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CANCEL	Call by reference	☑	Type reference (TYPE)	CHAR1		Einstelliges Kennzeichen	20010626

#	Exception	Resumable	Description	Created on
1	FAILED	☐	interner fehler	20010626

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ITO_CHASEL	Call by reference	☐	Type reference (TYPE)	UPC_YTO_CHASEL		Merkmalsselektion	20010626
2	Importing	I_AREA	Call by reference	☐	Type reference (TYPE)	UPC_Y_AREA		Planungsgebiet	20010626
3	Importing	I_PLEVEL	Call by reference	☐	Type reference (TYPE)	UPC_Y_PLEVEL		Planungsebene	20010626
4	Importing	I_READ_ONLY	Call by reference	☐	Type reference (TYPE)	CHAR1	' '	Einstelliges Kennzeichen	20010626
5	Importing	I_TEXT_DOCS	Value transfer	☐	Type reference (TYPE)	CHAR1	' '	Flag: Nur Textdokumente	20030331

#	Exception	Resumable	Description	Created on
1	FAILED	☐	interner Fehler	20010626

Method CONVERT_DOC_SEL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_DOC_SEL	Call by reference	☐	Type reference (TYPE)	ANY			20010720
2	Importing	IS_DOC_SEL	Call by reference	☐	Type reference (TYPE)	ANY			20010720

Method CONVERT_DOC_SEL on class CL_SEM_MP_DOC_APPL has no exception.

Method CREATE_DOCUMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_CANCEL	Call by reference	☐	Type reference (TYPE)	CHAR1		Einstelliges Kennzeichen	20010709
2	Importing	IS_DOC_SEL	Call by reference	☐	Type reference (TYPE)	ANY			20010626

#	Exception	Resumable	Description	Created on
1	FAILED	☐	interner Fehler	20010626

Method DELETE_DOCUMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_DOC_SEL	Call by reference	☐	Type reference (TYPE)	ANY			20010626

#	Exception	Resumable	Description	Created on
1	FAILED	☐	interner Fehler	20010626

Method FILL_CHAVL_INT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ETO_CHAVL	Call by reference	☐	Type reference (TYPE)	UPC_YTO_CHACOMB		Merkmalskombination	20010627
2	Importing	IS_DOC_SEL	Call by reference	☐	Type reference (TYPE)	ANY			20010627

Method FILL_CHAVL_INT on class CL_SEM_MP_DOC_APPL has no exception.

Method GET_CONTROL_CONTAINER Signature

Method GET_CONTROL_CONTAINER on class CL_SEM_MP_DOC_APPL has no parameter.
Method GET_CONTROL_CONTAINER on class CL_SEM_MP_DOC_APPL has no exception.

Method GET_DESCR_LIST Signature

Method GET_DESCR_LIST on class CL_SEM_MP_DOC_APPL has no parameter.
Method GET_DESCR_LIST on class CL_SEM_MP_DOC_APPL has no exception.

Method GET_DOC_FLAG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_HAS_DOCUMENT	Call by reference	☐	Type reference (TYPE)	UPP_Y_DOC		Doc_id als GUID	20010626
2	Importing	IS_DOC_SEL	Call by reference	☐	Type reference (TYPE)	ANY			20010626

#	Exception	Resumable	Description	Created on
1	FAILED	☐	Interner Fehler	20010626

Method GET_DOC_FROM_IDS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ETO_DOCUMENT_LONG	Call by reference	☐	Type reference (TYPE)	UPC_YTO_DOCUMENT_LONG		Tabelle für Dokumente	20010626
2	Importing	ITO_DOC_ID	Call by reference	☐	Type reference (TYPE)	UPC_YTO_DOC_ID_LONG		Tabelle langer Doc-Id's	20010626

Method GET_DOC_FROM_IDS on class CL_SEM_MP_DOC_APPL has no exception.

Method GET_DOC_IDS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ETO_DOC_ID	Call by reference	☐	Type reference (TYPE)	UPC_YTO_DOC_ID_LONG		Tabelle langer Doc-Id's	20010626
2	Importing	IS_DOC_SEL	Call by reference	☐	Type reference (TYPE)	ANY			20010626

#	Exception	Resumable	Description	Created on
1	FAILED	☐	Interner Fehler	20010626

Method GET_NO_EXCEL_DOCS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_NO_EXCEL_DOCS	Call by reference	☐	Type reference (TYPE)	CHAR1		Einstelliges Kennzeichen	20040329

Method GET_NO_EXCEL_DOCS on class CL_SEM_MP_DOC_APPL has no exception.

Method OPEN_DOCUMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_DOC_SEL	Call by reference	☐	Type reference (TYPE)	ANY			20010626
2	Importing	I_READ_ONLY	Call by reference	☑	Type reference (TYPE)	CHAR1			20030717

#	Exception	Resumable	Description	Created on
1	FAILED	☐	interner fehler	20010626

Method OPEN_DOCUMENT_AS_P Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CREATE	Call by reference	☑	Type reference (TYPE)	CHAR1		Einstelliges Kennzeichen	20011012
2	Importing	I_READ_ONLY	Call by reference	☑	Type reference (TYPE)	CHAR1			20030717
3	Changing	XS_DOC	Call by reference	☐	Type reference (TYPE)	UPC_YS_DOC		BDS Dokument	20011012

#	Exception	Resumable	Description	Created on
1	FAILED	☐	Interner Fehler	20011012

Method OPEN_DOCUMENT_P Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CREATE	Call by reference	☑	Type reference (TYPE)	CHAR1		Einstelliges Kennzeichen	20010626
2	Importing	I_READ_ONLY	Call by reference	☑	Type reference (TYPE)	CHAR1			20030717
3	Changing	XS_DOC	Call by reference	☐	Type reference (TYPE)	UPC_YS_DOC		BDS Dokument	20010626

#	Exception	Resumable	Description	Created on
1	FAILED	☐	Interner Fehler	20010626

Method READ_DOCUMENT Signature

Method READ_DOCUMENT on class CL_SEM_MP_DOC_APPL has no parameter.
Method READ_DOCUMENT on class CL_SEM_MP_DOC_APPL has no exception.

Method SAVE Signature

Method SAVE on class CL_SEM_MP_DOC_APPL has no parameter.

#	Exception	Resumable	Description	Created on
1	FAILED	☐	interner Fehler	20010626

Event Signatures

Event NEW_OK_CODE Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	FCODE	Exporting	Value transfer	☐	Type reference (TYPE)	UI_FUNC		Funktionscode	20010706

History

Last changed by/on	SAP	20130531
SAP Release Created in	3.1A