SAP ABAP Class CL_SEM_MP_DOCUMENTS (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_DOCUMENTS
Short Description	Class for Documents in Manual Planning
Super Class
Instantiability of a Class	0	Private
Final	☑

General Data

Message Class	UPP_DOC
Program status
Category	0
Package	UPP	SEM-BPS: Planning Processor and Layout Builder
Created	20010607	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)

Interfaces

Class CL_SEM_MP_DOCUMENTS has no interface implemented.

Friends

Class CL_SEM_MP_DOCUMENTS 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		Planning Area	20010607
2	C_DOCS_WITH_INFOPROV	Constant	Private	☐	Type reference (TYPE)	CHAR30	'DOCS_WITH_INFOPROV'	InfoProvider Assignment of Documents	20051205
3	C_DOC_TYPE_PLAIN	Constant	Public	☐	Type reference (TYPE)	BDS_MIMETP	'text/plain'	Document Type Pure Text	20010717
4	C_INIT_VALUE	Constant	Private	☐	Type reference (TYPE)	CHAR1	'#'	Initial Value	20010727
5	C_NAME_DOC_ID	Constant	Public	☐	Type reference (TYPE)	CHAR10	'_DOC_ID'	Name Doc_id in Structure	20010608
6	C_NAME_KEYF	Constant	Public	☐	Type reference (TYPE)	CHAR10	'_BKENNZAHL'	Name Key Figure in Structure	20010608
7	C_NAME_KEYF_DS	Constant	Private	☐	Type reference (TYPE)	CHAR10	'KYFNM_NAME'	Name Key Figure in Document Storage	20010705
8	R_AREA_ATTR	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_SEM_PLANAREA_ATTRIBUTES		Planning Area Attributes	20010611
9	TEXT_DOCS	Static Attribute	Private	☐	Type reference (TYPE)	CHAR1		Only Use Text Documents	20010717
10	TEXT_DOCS_ALLOWED	Instance attribute	Public	☐	Type reference (TYPE)	CHAR1		Text Documents Allowed	20011102
11	TO_DOC	Static Attribute	Protected	☐	Type reference (TYPE)	UPC_YTO_DOC		Table for Documents	20010607
12	TO_DOC_LEVEL	Instance attribute	Private	☐	Type reference (TYPE)	YTO_DOC_LEVEL		Table with Document Levels	20010607
13	TO_INSTANCES	Static Attribute	Protected	☐	Type reference (TYPE)	YTO_INSTANCES			20010607
14	T_SELECTION	Instance attribute	Protected	☐	Type reference (TYPE)	YT_SELECTION			20010608

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_DOC_IN_LEVEL	Instance method	Private	Method	Checks, Whether Document Is in Desired Level	20010627
2	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	20010607
3	CONVERT_CHASEL_FOR_DB	Instance method	Private	Method	Convert Selection Table for Database	20010727
4	CONVERT_CHAVL_FOR_DB	Static method	Private	Method	Converts chavl Table from initial to #	20010727
5	CONVERT_CHAVL_FROM_DB	Instance method	Private	Method	Converts chavl Table from # to initial	20010727
6	CREATE_DOC_LEVEL	Instance method	Private	Method	Generates a Table Entry for a Document Level	20010608
7	DELETE_DOC_SELS	Instance method	Private	Method	Deletes Enties from Selection Table with Specified doc_id	20010607
8	DOCS_WITH_INFOPROV	Static method	Public	Method	Is InfoProvider assignment for documents switched on?	20051205
9	FILL_DOC_SEL	Instance method	Private	Method	Fills Reference Table	20010607
10	GET_DOCUMENTS_FROM_BUF	Instance method	Private	Method	Gets Documents from the Buffer	20010704
11	GET_DOCUMENT_CONTENT	Instance method	Public	Method	Delivers the Content of a Document	20010607
12	GET_DOCUMENT_LIST	Instance method	Public	Method	Fills the Document Table	20010607
13	GET_DOC_LEVEL	Instance method	Public	Method	Delivers a Document Level (Exact) and Selections	20010625
14	GET_INSTANCE	Static method	Public	Method	Gets Instance	20010607
15	GET_INSTANCE_P	Static method	Private	Method	Generates the Respective Instance	20010607
16	GET_TOCHA_FROM_TOCHAVL	Instance method	Private	Method	Fills to_cha from to_chavl	20010704
17	MAP_DSKEYF_TO_KEYF	Static method	Private	Method	Changes Name of Key Figure (Document Storage to Internal)	20010705
18	MAP_KEYF_TO_DSKEYF	Static method	Private	Method	Changes Name of Key Figure (Internal to Document Storage)	20010705
19	MODIFY_CHASEL	Instance method	Private	Method	Fills Missing Entries in the Selection Table	20010704
20	SAVE	Static method	Public	Method	Saves Documents in the Document Storage	20010607
21	UPDATE_DOCUMENT_LIST	Instance method	Public	Method	Writes New/Changes Documents into Buffer	20010607
22	UPDATE_DOC_ID	Instance method	Private	Method	Adapts the doc_ids	20010607

Events

Class CL_SEM_MP_DOCUMENTS has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	YS_DOC_ID	Protected	See coding			20010607	begin of YS_DOC_ID, doc_id type upc_y_doc_id_long, end of YS_DOC_ID
2	YS_DOC_LEVEL	Protected	See coding			20010607	begin of YS_DOC_level, hndl_level type UPP_Y_HNDL_LEVEL, to_cha type upc_yto_cha, to_doc_sel type ref to data, end of ys_doc_level
3	YS_INSTANCES	Protected	See coding			20010607	begin of YS_INSTANCES, area type upc_y_area, r_instance type ref to cl_sem_mp_documents, end of YS_INSTANCES
4	YS_SELECTION	Protected	See coding			20010608	begin of YS_SELECTION, to_chasel type UPC_YTO_CHASEL, end of YS_SELECTION
5	YTO_DOC_ID	Protected	See coding			20010607	YTO_DOC_ID type sorted table of ys_doc_id with unique key doc_id
6	YTO_DOC_LEVEL	Protected	See coding			20010607	YTO_DOC_LEVEL type sorted table of ys_doc_level with unique key hndl_level
7	YTO_INSTANCES	Protected	See coding			20010607	YTO_INSTANCES type sorted table of YS_INSTANCES with unique key area
8	YT_SELECTION	Protected	See coding			20010608

Method Signatures

Method CHECK_DOC_IN_LEVEL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_CONTAINED	Call by reference	☐	Type reference (TYPE)	CHAR1		Einstelliges Kennzeichen	20010627
2	Importing	IS_DOCUMENT	Call by reference	☐	Type reference (TYPE)	UPC_YS_DOCUMENT		BDS Dokument	20010627
3	Importing	ITO_CHA	Call by reference	☐	Type reference (TYPE)	UPC_YTO_CHA		Merkmale	20010627

Method CHECK_DOC_IN_LEVEL on class CL_SEM_MP_DOCUMENTS has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_AREA	Call by reference	☐	Type reference (TYPE)	UPC_Y_AREA		Planungsgebiet	20010607
2	Importing	I_TEXT_DOCS	Call by reference	☐	Type reference (TYPE)	CHAR1		Einstelliges Kennzeichen	20010717

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

Method CONVERT_CHASEL_FOR_DB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ETO_CHASEL_DB	Call by reference	☐	Type reference (TYPE)	UPC_YTO_CHASEL		Merkmalsselektion	20010727
2	Importing	ITO_CHA	Call by reference	☐	Type reference (TYPE)	UPC_YTO_CHA		Merkmale	20010727
3	Importing	ITO_CHASEL	Call by reference	☐	Type reference (TYPE)	UPC_YTO_CHASEL		Merkmalsselektion	20010727

Method CONVERT_CHASEL_FOR_DB on class CL_SEM_MP_DOCUMENTS has no exception.

Method CONVERT_CHAVL_FOR_DB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_AREA	Call by reference	☐	Type reference (TYPE)	UPC_Y_AREA		Planungsgebiet	20010727
2	Changing	XTO_CHAVL	Call by reference	☐	Type reference (TYPE)	UPC_YTO_CHACOMB		Merkmalskombination	20010727

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

Method CONVERT_CHAVL_FROM_DB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ITO_CHA	Call by reference	☐	Type reference (TYPE)	UPC_YTO_CHA		Merkmale	20010727
2	Changing	XTO_CHAVL	Call by reference	☐	Type reference (TYPE)	UPC_YTO_CHACOMB		Merkmalskombination	20010727

Method CONVERT_CHAVL_FROM_DB on class CL_SEM_MP_DOCUMENTS has no exception.

Method CREATE_DOC_LEVEL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ES_DOC_LEVEL	Value transfer	☐	Type reference (TYPE)	YS_DOC_LEVEL			20010608
2	Importing	ITO_CHA	Call by reference	☐	Type reference (TYPE)	UPC_YTO_CHA		Merkmale	20010608

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

Method DELETE_DOC_SELS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ITO_DOC_ID	Call by reference	☐	Type reference (TYPE)	YTO_DOC_ID		Laufzeit Dokument-Identifier	20010607

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

Method DOCS_WITH_INFOPROV Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_WITH_INFOPROV	Call by reference	☐	Type reference (TYPE)	C			20051205
2	Importing	I_ASSIGNMENT_OFF	Call by reference	☑	Type reference (TYPE)	C		Infoproviderzuordnung aussschalten	20051205
3	Importing	I_ASSIGNMENT_ON	Call by reference	☑	Type reference (TYPE)	C		Infoproviderzuordnung einschalten	20051205

Method DOCS_WITH_INFOPROV on class CL_SEM_MP_DOCUMENTS has no exception.

Method FILL_DOC_SEL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_DOC	Call by reference	☐	Type reference (TYPE)	UPC_YS_DOC		BDS Dokument	20010607
2	Importing	ITO_CHA	Call by reference	☐	Type reference (TYPE)	UPC_YTO_CHA		Merkmale	20010622

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

Method GET_DOCUMENTS_FROM_BUF 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		BDS Dokumente	20010704
2	Importing	ITO_CHA	Call by reference	☐	Type reference (TYPE)	UPC_YTO_CHA		Merkmale	20010704
3	Importing	ITO_CHASEL	Call by reference	☐	Type reference (TYPE)	UPC_YTO_CHASEL		Merkmalsselektion	20010704

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

Method GET_DOCUMENT_CONTENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_AS_CONTENT	Call by reference	☐	Type reference (TYPE)	UPC_YT_AS_CONTENT		Ascii-Tabelle	20010717
2	Exporting	ET_CONTENT	Call by reference	☐	Type reference (TYPE)	UPC_T_CONTENT		Inhalt eines Dokuments	20010607
3	Importing	I_DOC_ID	Call by reference	☐	Type reference (TYPE)	UPC_Y_DOC_ID_LONG		Laufzeit Dokument-Identifier	20010607

#	Exception	Resumable	Description	Created on
1	FAILED	☐	Interner Fehler	20010608
2	NO_DOCUMENT_FOUND	☐	Kein Dokument gefunden	20010814

Method GET_DOCUMENT_LIST 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		BDS Dokumente	20010607
2	Importing	ITO_CHA	Call by reference	☐	Type reference (TYPE)	UPC_YTO_CHA		Merkmale	20010703
3	Importing	ITO_CHASEL	Call by reference	☐	Type reference (TYPE)	UPC_YTO_CHASEL		Merkmalsselektion	20010607

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

Method GET_DOC_LEVEL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ETO_DOC	Call by reference	☐	Type reference (TYPE)	UPC_YTO_DOC		Tabelle für Dokumente	20010625
2	Exporting	ETO_DOC_SEL	Call by reference	☐	Object reference (TYPE REF TO)	DATA		Selektionen für Dokumente	20010625
3	Exporting	E_HNDL_LEVEL	Call by reference	☐	Type reference (TYPE)	SYSUUID_22		UUID in komprimierter Form (22 Stellen UUENCODEd)	20010625
4	Importing	ITO_CHA	Call by reference	☐	Type reference (TYPE)	UPC_YTO_CHA		Merkmale	20010625

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

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ER_INSTANCE	Value transfer	☐	Object reference (TYPE REF TO)	CL_SEM_MP_DOCUMENTS		Klasse für Dokumente in Manueller Planung	20010607
2	Importing	I_AREA	Call by reference	☐	Type reference (TYPE)	UPC_Y_AREA		Planungsgebiet	20010607
3	Importing	I_TEXT_DOCS	Call by reference	☐	Type reference (TYPE)	CHAR1	' '	Einstelliges Kennzeichen	20010717

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

Method GET_INSTANCE_P Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ER_INSTANCE	Call by reference	☐	Object reference (TYPE REF TO)	CL_SEM_MP_DOCUMENTS		Klasse für Dokumente in Manueller Planung	20010607
2	Importing	I_AREA	Call by reference	☐	Type reference (TYPE)	UPC_Y_AREA		Planungsgebiet	20010607
3	Importing	I_TEXT_DOCS	Call by reference	☐	Type reference (TYPE)	CHAR1		Einstelliges Kennzeichen	20010717

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

Method GET_TOCHA_FROM_TOCHAVL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ETO_CHA	Call by reference	☐	Type reference (TYPE)	UPC_YTO_CHA		Merkmale	20010704
2	Importing	ITO_CHAVL	Call by reference	☐	Type reference (TYPE)	UPC_YTO_CHACOMB		Merkmalskombination	20010704

Method GET_TOCHA_FROM_TOCHAVL on class CL_SEM_MP_DOCUMENTS has no exception.

Method MAP_DSKEYF_TO_KEYF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	XTO_CHAVL	Call by reference	☐	Type reference (TYPE)	UPC_YTO_CHACOMB		Merkmalskombination	20010705

Method MAP_DSKEYF_TO_KEYF on class CL_SEM_MP_DOCUMENTS has no exception.

Method MAP_KEYF_TO_DSKEYF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	XTO_CHAVL	Call by reference	☐	Type reference (TYPE)	UPC_YTO_CHACOMB		Merkmalskombination	20010705

Method MAP_KEYF_TO_DSKEYF on class CL_SEM_MP_DOCUMENTS has no exception.

Method MODIFY_CHASEL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ITO_CHA	Call by reference	☐	Type reference (TYPE)	UPC_YTO_CHA		Merkmale	20010704
2	Changing	XTO_CHASEL	Call by reference	☐	Type reference (TYPE)	UPC_YTO_CHASEL		Merkmalsselektion	20010704

Method MODIFY_CHASEL on class CL_SEM_MP_DOCUMENTS has no exception.

Method SAVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ETO_DOC_ID_MAP	Call by reference	☐	Type reference (TYPE)	UPC_YTO_DOC_ID_MAP		Tabelle Abbildung alte zur neuer Doc_id	20010607
2	Importing	I_SAVE_MODE	Call by reference	☐	Type reference (TYPE)	UPC_Y_DOC_SOURCE		letzte Quelle eines geänderten Dokuments	20010607

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

Method UPDATE_DOCUMENT_LIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ITO_CHA	Call by reference	☑	Type reference (TYPE)	UPC_YTO_CHA		Merkmale	20010622
2	Importing	ITO_DOC	Call by reference	☐	Type reference (TYPE)	UPC_YTO_DOC		BDS Dokument	20010607

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

Method UPDATE_DOC_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_NEW_DOC_ID	Call by reference	☐	Type reference (TYPE)	UPC_Y_DOC_ID_LONG		Laufzeit Dokument-Identifier	20010607
2	Importing	I_OLD_DOC_ID	Call by reference	☐	Type reference (TYPE)	UPC_Y_DOC_ID_LONG		Laufzeit Dokument-Identifier	20010607

Method UPDATE_DOC_ID on class CL_SEM_MP_DOCUMENTS has no exception.

History

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