SAP ABAP Class CL_UPARU_DOC_APPL (MAP-SEM Documents Management)

Hierarchy

☛ SAP_BW (Software Component) SAP Business Warehouse
   ⤷ BW-PLA-BPS (Application Component) Business Planning and Simulation
     ⤷ UPARU (Package) Retail Assortment Planning User Interface

Properties

Class	CL_UPARU_DOC_APPL
Short Description	MAP-SEM Documents Management
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class	UPP_DOC
Program status
Category	0
Package	UPARU	Retail Assortment Planning User Interface
Created	20050406	SAP
Last change	20141101
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_UPARU_DOC_APPL has no interface implemented.

Friends

Class CL_UPARU_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			20050406
2	C_DOC_SOURCE	Constant	Private	☐	Type reference (TYPE)	UPC_Y_DOC_SOURCE	'D'		20050406
3	C_DOC_TYPE_TEXT	Constant	Private	☐	Type reference (TYPE)	CHAR4	SOI_DOCFORMAT_TEXT		20050406
4	C_INIT_VALUE	Constant	Private	☐	Type reference (TYPE)	CHAR1	'#'		20050406
5	C_TODO_DELETE	Constant	Private	☐	Type reference (TYPE)	UPC_Y_TODO	'D'		20050406
6	C_TODO_INSERT	Constant	Private	☐	Type reference (TYPE)	UPC_Y_TODO	'I'		20050406
7	C_TODO_UPDATE	Constant	Private	☐	Type reference (TYPE)	UPC_Y_TODO	'U'		20050406
8	HNDL_LEVEL	Instance attribute	Private	☐	Type reference (TYPE)	UPP_Y_HNDL_LEVEL			20050406
9	LEVEL	Instance attribute	Private	☐	Type reference (TYPE)	UPC_Y_PLEVEL			20050406
10	READ_ONLY	Instance attribute	Private	☐	Type reference (TYPE)	CHAR1			20050406
11	RETCODE	Instance attribute	Private	☐	Type reference (TYPE)	SOI_RET_STRING			20050406
12	R_AREA_ATTR	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_SEM_PLANAREA_ATTRIBUTES			20050406
13	R_CONTAINER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_GUI_CONTAINER		Container for Custom Controls in the Screen Area	20050406
14	R_CONTROL	Instance attribute	Private	☐	Object reference (TYPE REF TO)	I_OI_OLE_CONTAINER_CONTROL		Document Container Control Interface	20050406
15	R_MP_DOCUMENTS	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_SEM_MP_DOCUMENTS			20050406
16	TO_CHASEL	Instance attribute	Private	☐	Type reference (TYPE)	UPC_YTO_CHASEL			20050406
17	TO_CHA_COM	Instance attribute	Private	☐	Type reference (TYPE)	UPC_YTO_CHA			20050406
18	TO_DOC	Instance attribute	Private	☐	Type reference (TYPE)	UPC_YTO_DOC			20050406
19	TO_DOC_SEL	Instance attribute	Private	☐	Object reference (TYPE REF TO)	DATA			20050406
20	T_DESCR_LIST	Instance attribute	Private	☐	Type reference (TYPE)	UPP_YT_DOC_TYPE_LIST		List of Registered Document Types with Mime Type	20050406

Methods

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

Events

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

Types

Class CL_UPARU_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	' '	Indicator to Delete Container	20050406

Method CLOSE on class CL_UPARU_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		Single-Character Indicator	20050406

#	Exception	Resumable	Description	Created on
1	FAILED	☐	Internal Error	20050406

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		Characteristic Selection	20050406
2	Importing	I_AREA	Call by reference	☐	Type reference (TYPE)	UPC_Y_AREA		Planning Area	20050406
3	Importing	I_PLEVEL	Call by reference	☐	Type reference (TYPE)	UPC_Y_PLEVEL		Planning Level	20050406
4	Importing	I_READ_ONLY	Call by reference	☐	Type reference (TYPE)	CHAR1	' '	Single-Character Indicator	20050406
5	Importing	I_TEXT_DOCS	Value transfer	☐	Type reference (TYPE)	CHAR1	' '	Indicator: Only Text Documents	20050406

#	Exception	Resumable	Description	Created on
1	FAILED	☐	Internal Error	20050406

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			20050406
2	Importing	IS_DOC_SEL	Call by reference	☐	Type reference (TYPE)	ANY			20050406

Method CONVERT_DOC_SEL on class CL_UPARU_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		Single-Character Indicator	20050406
2	Importing	IS_DOC_SEL	Call by reference	☐	Type reference (TYPE)	ANY			20050406

#	Exception	Resumable	Description	Created on
1	FAILED	☐	Internal Error	20050406

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			20050406

#	Exception	Resumable	Description	Created on
1	FAILED	☐	Internal Error	20050406

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		Characteristics Combination	20050406
2	Importing	IS_DOC_SEL	Call by reference	☐	Type reference (TYPE)	ANY			20050406

Method FILL_CHAVL_INT on class CL_UPARU_DOC_APPL has no exception.

Method GET_CONTROL_CONTAINER Signature

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

Method GET_DESCR_LIST Signature

Method GET_DESCR_LIST on class CL_UPARU_DOC_APPL has no parameter.
Method GET_DESCR_LIST on class CL_UPARU_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 as GUID	20050406
2	Importing	IS_DOC_SEL	Call by reference	☐	Type reference (TYPE)	ANY			20050406

#	Exception	Resumable	Description	Created on
1	FAILED	☐	Internal Error	20050406

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		Table for Documents	20050406
2	Importing	ITO_DOC_ID	Call by reference	☐	Type reference (TYPE)	UPC_YTO_DOC_ID_LONG		Table of Long Doc IDs	20050406

Method GET_DOC_FROM_IDS on class CL_UPARU_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		Table of Long Doc IDs	20050406
2	Importing	IS_DOC_SEL	Call by reference	☐	Type reference (TYPE)	ANY			20050406

#	Exception	Resumable	Description	Created on
1	FAILED	☐	Internal Error	20050406

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			20050406
2	Importing	I_READ_ONLY	Call by reference	☑	Type reference (TYPE)	CHAR1		Single-Character Flag	20050406

#	Exception	Resumable	Description	Created on
1	FAILED	☐	Internal Error	20050406

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		Single-Character Indicator	20050406
2	Importing	I_READ_ONLY	Call by reference	☑	Type reference (TYPE)	CHAR1		Single-Character Flag	20050406
3	Changing	XS_DOC	Call by reference	☐	Type reference (TYPE)	UPC_YS_DOC		BDS Document	20050406

#	Exception	Resumable	Description	Created on
1	FAILED	☐	Internal Error	20050406

Method OPEN_DOCUMENT_P 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		Operation has been cancelled without saving the document	20050630
2	Importing	I_CREATE	Call by reference	☑	Type reference (TYPE)	CHAR1		Single-Character Indicator	20050406
3	Importing	I_READ_ONLY	Call by reference	☑	Type reference (TYPE)	CHAR1		Single-Character Flag	20050406
4	Changing	XS_DOC	Call by reference	☐	Type reference (TYPE)	UPC_YS_DOC		BDS Document	20050406

#	Exception	Resumable	Description	Created on
1	FAILED	☐	Internal Error	20050406

Method SAVE Signature

Method SAVE on class CL_UPARU_DOC_APPL has no parameter.

#	Exception	Resumable	Description	Created on
1	FAILED	☐	Internal Error	20050406

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		Function Code	20050406

History

Last changed by/on	SAP	20141101
SAP Release Created in	702