SAP ABAP Class CL_RSR_WWW_DOC_MAINTENANCE (Maintenance of Documents as Help Window)

Hierarchy

☛ SAP_BW (Software Component) SAP Business Warehouse
   ⤷ BW-BEX-ET (Application Component) End User Technology
     ⤷ RS_WEB_RUNTIME_3X (Package) Web Runtime to BW Release 3.x (Outside CORE)

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_RSR_WWW_HELP_WINDOW	Help Window in Web Reporting	20010430

Properties

Class	CL_RSR_WWW_DOC_MAINTENANCE
Short Description	Maintenance of Documents as Help Window
Super Class	CL_RSR_WWW_HELP_WINDOW	Help Window in Web Reporting
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	RS_WEB_RUNTIME_3X	Web Runtime to BW Release 3.x (Outside CORE)
Created	20010430	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

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

Interfaces

Class CL_RSR_WWW_DOC_MAINTENANCE has no interface implemented.

Friends

Class CL_RSR_WWW_DOC_MAINTENANCE has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	C_CMD_CLOSE	Constant	Public	☐	Type reference (TYPE)	RSRCMDID	'CLOSE'	Close Window	20010430
2	C_CMD_CREATE	Constant	Public	☐	Type reference (TYPE)	RSRCMDID	'CREATE'	Create / Initialize	20010430
3	C_CMD_DELETE	Constant	Public	☐	Type reference (TYPE)	RSRCMDID	'DELETE'	Delete Document	20010808
4	C_CMD_DELETE_LOCK	Constant	Public	☐	Type reference (TYPE)	RSRCMDID	'DELETE_LOCK'	Delete Locks	20020910
5	C_CMD_DELETE_PROP	Constant	Public	☐	Type reference (TYPE)	RSRCMDID	'DELETE_PROP'	Delete Property	20020225
6	C_CMD_SAVE	Constant	Public	☐	Type reference (TYPE)	RSRCMDID	'SAVE'	Save Document	20010430
7	C_CMD_UNLOAD	Constant	Public	☐	Type reference (TYPE)	RSRCMDID	'UNLOAD'	Unload - Unlock Document	20030103
8	C_FUNCTION_DELETE_PROP	Constant	Private	☐	Type reference (TYPE)	STRING	'SAPBWdocumentDelProp'	JS Function for Deleting a Property	20020225
9	C_FUNCTION_ON_UNLOAD	Constant	Private	☐	Type reference (TYPE)	STRING	'SAPBWdocumentOnUnload'	JS Function for Handling on Unload (Unlock)	20030103
10	C_PARAMETER_CONTENT	Constant	Private	☐	Type reference (TYPE)	RSRPARAMETERID	'CONTENT'	Content CM Document	20010430
11	C_PARAMETER_DESCRIPTION	Constant	Private	☐	Type reference (TYPE)	RSRPARAMETERID	'DESCRIPTION'	Description CM Document	20010430
12	C_PARAMETER_INFOPROV_SPECIFIC	Constant	Private	☐	Type reference (TYPE)	RSRPARAMETERID	'INFOPROV_SPECIFIC'	Query-Specific CM Document	20010509
13	C_PARAMETER_PROP_LINE	Constant	Private	☐	Type reference (TYPE)	RSRPARAMETERID	'DOC_PROP_LINE'	Property Row	20020225
14	C_PARAMETER_QUERY_SPECIFIC	Constant	Private	☐	Type reference (TYPE)	RSRPARAMETERID	'QUERY_SPECIFIC'	Query-Specific CM Document	20010509
15	C_PARAMETER_RELATIVE_URL	Constant	Private	☐	Type reference (TYPE)	RSRPARAMETERID	'KW_RELATIVE_URL'	Technical Name CM Document	20010430
16	C_TEXTAREA_COLUMNS	Constant	Private	☐	Type reference (TYPE)	I	80	Text Area Width	20020226
17	P_ALREADY_SAVED	Instance attribute	Private	☐	Type reference (TYPE)	RS_BOOL		= 'X' Document has already been saved by this instance	20030123
18	P_CHECKOUT_USER	Instance attribute	Private	☐	Type reference (TYPE)	SY-UNAME		User Who Checked out Document	20020909
19	P_CONTENT	Instance attribute	Private	☐	Type reference (TYPE)	STRING		Content CM Document	20010509
20	P_DELETED	Instance attribute	Private	☐	Type reference (TYPE)	RS_BOOL		Document deleted	20010808
21	P_DESCR	Instance attribute	Private	☐	Type reference (TYPE)	SDOK_DESCR		Short Description	20010509
22	P_DISPLAY_ONLY	Instance attribute	Private	☐	Type reference (TYPE)	RS_BOOL	RS_C_FALSE	= 'X' Display Mode	20021220
23	P_FRAME	Instance attribute	Private	☐	Type reference (TYPE)	STRING		Frame in Which the Help Window Was Sent	20031110
24	P_IGNORE_UNLOAD	Instance attribute	Private	☐	Type reference (TYPE)	RS_BOOL		= 'X' Ignore on_unload (after saving)	20031117
25	P_INFOPROV_SPECIFIC	Instance attribute	Private	☐	Type reference (TYPE)	RS_BOOL		='X': Document is InfoProvider-Specific	20010509
26	P_LOCK_USER	Instance attribute	Private	☐	Type reference (TYPE)	SY-UNAME		User Who Locked Document	20020909
27	P_NOT_AUTHORIZED	Instance attribute	Private	☐	Type reference (TYPE)	RS_BOOL		= 'X' No Maintenance Authorization	20021220
28	P_NO_DOCUMENT_YET_READ	Instance attribute	Private	☐	Type reference (TYPE)	RS_BOOL		= 'X' No Document Has Been Loaded Yet	20031117
29	P_QUERY_SPECIFIC	Instance attribute	Private	☐	Type reference (TYPE)	RS_BOOL		='X': Document is Query-Specific	20010509
30	P_RELATIVE_URL	Instance attribute	Private	☐	Type reference (TYPE)	SKWF_URLP		Name	20010509
31	P_R_CALLER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_RSOD_DOC_MAINT_CALLER		Called Up By in Docu Maintenance in Web	20030203
32	P_R_CLASS	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_RSOD_CLASS		Document Class	20020510
33	P_R_DOC	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_RSOD_DOC		Saved Document Being Edited Currently	20010509
34	P_R_WWW_DOC_MAINT	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_EX_RSOD_WWW_DOC_MAINT		BAdI Interface IF_EX_RSOD_WWW_DOC_MAINT	20030131
35	P_T_PROP	Instance attribute	Private	☐	Type reference (TYPE)	SDOKPROPTYS		Document properties	20020225
36	P_T_PROP_HIDE	Instance attribute	Private	☐	Type reference (TYPE)	SDOKPROPTNS		Hidden Document Properties	20030131
37	P_VERSION_HANDLING	Instance attribute	Private	☐	Type reference (TYPE)	RSOD_VERSION_HANDLING		Version Management of Documents in Web	20030123

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	DELETE_DOCUMENT	Instance method	Private	Method	Save Document	20010808
2	DELETE_PROPERTY	Instance method	Private	Method	Save Document	20020225
3	END_TABLE_ROW	Instance method	Private	Method	Start Table Row	20020226
4	GET_DOCUMENT_PROPERTIES	Instance method	Private	Method	Gets the Properties of an Existing Document	20031113
5	GET_FORM_NAME	Instance method	Private	Method	Gets Name of Form	20010716
6	GET_PROPERTIES	Instance method	Private	Method	Get Latest Properties (from Context or Document)	20010907
7	GET_SUBCOMMAND_PARAMETER	Instance method	Private	Method	Gets Parameters for Sub-command	20020225
8	GET_SUBCOMMAND_URL	Instance method	Private	Method	Delivers the URL for a sub-command	20010808
9	GET_TEMPLATE	Instance method	Private	Method	Gets Template That is Calling Up	20030131
10	GET_TEXT_ID_SYSTEM_PROPOSAL	Static method	Public	Method	Gets the Text "ID Determined by System"	20031112
11	INIT_CMD_CREATE	Instance method	Private	Method	Initialization with (Sub)Command CREATE	20031113
12	INSERT_JS_DELETE_PROP	Instance method	Private	Method	Insertion of JS Function SAPBWdocumentDelProp	20020225
13	LOCK_DOCUMENT	Instance method	Private	Method	Lock document	20030103
14	ON_UNLOAD	Instance method	Private	Method	Handling OnUnload Event	20030103
15	OPEN_FORM_TAG	Instance method	Private	Method	Opens FORM for Dropdown	20010502
16	READ_DOCUMENT	Instance method	Private	Method	Read Document (Read Properties if New Document)	20020225
17	READ_HELP_SERVICE_DATA	Instance method	Private	Method	Fills Member Variables with HTML Page Document Info	20020225
18	RENDER	Instance method	Private	Method	Render HTML	20010430
19	RENDER_BUTTONS	Instance method	Private	Method	Render buttons in user tables	20010808
20	RENDER_CHECK_BOX	Instance method	Private	Method	Render Checkbox (Obsolete)	20010509
21	RENDER_CLOSE_BUTTON	Instance method	Private	Method	Display Properties	20010612
22	RENDER_DELETE_BUTTON	Instance method	Private	Method	Display Properties	20010808
23	RENDER_DELETE_PROP_BUTTON	Instance method	Private	Method	Displays Button for Property Deletion	20020225
24	RENDER_EMPTY_COLUMN	Instance method	Private	Method	Generate Empty Column	20010716
25	RENDER_EMPTY_ROW	Instance method	Private	Method	Generate Empty Row	20010716
26	RENDER_INPUT_FIELD	Instance method	Private	Method	Render Entry Field	20010502
27	RENDER_PROPERTIES	Instance method	Private	Method	Display Properties	20010607
28	RENDER_SUBMIT_BUTTON	Instance method	Private	Method	Displays Submit Button	20010716
29	RESET	Instance method	Private	Method	Reset Member Attributes (Except Currect Document p_r_doc)	20010529
30	SAVE_DOCUMENT	Instance method	Private	Method	Save Document	20010808
31	SORT_PROPERTIES	Instance method	Private	Method	Sorting Document Properties (InfoProviders, Queries,..)	20020225
32	START_TABLE_ROW	Instance method	Private	Method	Start Table Row	20020226
33	UNLOAD_TO_HTML	Instance method	Private	Method	OnUnload Parts (JavaScript Funcs. / Build Body Extend)	20030103
34	UNLOCK_DOC_AND_RESET	Instance method	Private	Method	Unlock Document (Reset Status for Reading / Unloading)	20031117

Events

Class CL_RSR_WWW_DOC_MAINTENANCE has no event.

Types

Class CL_RSR_WWW_DOC_MAINTENANCE has no local type.

Method Signatures

Method DELETE_DOCUMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_R_PARAMETER	Call by reference	☐	Object reference (TYPE REF TO)	CL_RSR_PARAMETER		Parameter	20010808

Method DELETE_DOCUMENT on class CL_RSR_WWW_DOC_MAINTENANCE has no exception.

Method DELETE_PROPERTY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_INDEX	Call by reference	☐	Type reference (TYPE)	I		Index der Eigenschaft	20020225
2	Importing	I_R_PARAMETER	Call by reference	☐	Object reference (TYPE REF TO)	CL_RSR_PARAMETER		Parameter	20020225

Method DELETE_PROPERTY on class CL_RSR_WWW_DOC_MAINTENANCE has no exception.

Method END_TABLE_ROW Signature

Method END_TABLE_ROW on class CL_RSR_WWW_DOC_MAINTENANCE has no parameter.
Method END_TABLE_ROW on class CL_RSR_WWW_DOC_MAINTENANCE has no exception.

Method GET_DOCUMENT_PROPERTIES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_T_PROP	Value transfer	☐	Type reference (TYPE)	SDOKPROPTYS		SDOK: Liste von Name-Wert-Paaren	20031113

Method GET_DOCUMENT_PROPERTIES on class CL_RSR_WWW_DOC_MAINTENANCE has no exception.

Method GET_FORM_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_FORM_NAME	Value transfer	☐	Type reference (TYPE)	STRING			20010716

Method GET_FORM_NAME on class CL_RSR_WWW_DOC_MAINTENANCE has no exception.

Method GET_PROPERTIES Signature

Method GET_PROPERTIES on class CL_RSR_WWW_DOC_MAINTENANCE has no parameter.
Method GET_PROPERTIES on class CL_RSR_WWW_DOC_MAINTENANCE has no exception.

Method GET_SUBCOMMAND_PARAMETER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_SUBCMD	Call by reference	☐	Type reference (TYPE)	RSRCMDID		Subkommando	20020225
2	Returning	R_R_PARAMETER	Value transfer	☐	Object reference (TYPE REF TO)	CL_RSR_PARAMETER		Parameter	20020225

Method GET_SUBCOMMAND_PARAMETER on class CL_RSR_WWW_DOC_MAINTENANCE has no exception.

Method GET_SUBCOMMAND_URL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_SUBCMD	Call by reference	☐	Type reference (TYPE)	RSRCMDID		Subkommando	20010808
2	Returning	R_URL	Value transfer	☐	Type reference (TYPE)	STRING			20010808

Method GET_SUBCOMMAND_URL on class CL_RSR_WWW_DOC_MAINTENANCE has no exception.

Method GET_TEMPLATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_R_PAGE	Value transfer	☐	Object reference (TYPE REF TO)	CL_RSR_WWW_PAGE		Html Interface des Olap Prozessors	20030131

Method GET_TEMPLATE on class CL_RSR_WWW_DOC_MAINTENANCE has no exception.

Method GET_TEXT_ID_SYSTEM_PROPOSAL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_TEXT	Value transfer	☐	Type reference (TYPE)	STRING			20031112

Method GET_TEXT_ID_SYSTEM_PROPOSAL on class CL_RSR_WWW_DOC_MAINTENANCE has no exception.

Method INIT_CMD_CREATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_R_PARAMETER	Call by reference	☐	Object reference (TYPE REF TO)	CL_RSR_PARAMETER		Parameter	20031113

#	Exception	Resumable	Description	Created on
1	CX_RS_ERROR	☐	Allgemeiner Fehler mit Nachricht im CM Framework	20031113

Method INSERT_JS_DELETE_PROP Signature

Method INSERT_JS_DELETE_PROP on class CL_RSR_WWW_DOC_MAINTENANCE has no parameter.
Method INSERT_JS_DELETE_PROP on class CL_RSR_WWW_DOC_MAINTENANCE has no exception.

Method LOCK_DOCUMENT Signature

Method LOCK_DOCUMENT on class CL_RSR_WWW_DOC_MAINTENANCE has no parameter.
Method LOCK_DOCUMENT on class CL_RSR_WWW_DOC_MAINTENANCE has no exception.

Method ON_UNLOAD Signature

Method ON_UNLOAD on class CL_RSR_WWW_DOC_MAINTENANCE has no parameter.
Method ON_UNLOAD on class CL_RSR_WWW_DOC_MAINTENANCE has no exception.

Method OPEN_FORM_TAG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_HTML	Call by reference	☐	Type reference (TYPE)	STRING			20010502

Method OPEN_FORM_TAG on class CL_RSR_WWW_DOC_MAINTENANCE has no exception.

Method READ_DOCUMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_R_PARAMETER	Call by reference	☐	Object reference (TYPE REF TO)	CL_RSR_PARAMETER		Parameter	20020225

#	Exception	Resumable	Description	Created on
1	CX_RSOD	☐	Allgemeiner Fehler mit Nachricht im CM Framework	20020225

Method READ_HELP_SERVICE_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_R_PARAMETER	Call by reference	☐	Object reference (TYPE REF TO)	CL_RSR_PARAMETER		Parameter	20020225

Method READ_HELP_SERVICE_DATA on class CL_RSR_WWW_DOC_MAINTENANCE has no exception.

Method RENDER Signature

Method RENDER on class CL_RSR_WWW_DOC_MAINTENANCE has no parameter.

#	Exception	Resumable	Description	Created on
1	X_MESSAGE	☐	X Message	20010716

Method RENDER_BUTTONS Signature

Method RENDER_BUTTONS on class CL_RSR_WWW_DOC_MAINTENANCE has no parameter.
Method RENDER_BUTTONS on class CL_RSR_WWW_DOC_MAINTENANCE has no exception.

Method RENDER_CHECK_BOX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_PARAMETER	Call by reference	☐	Type reference (TYPE)	RSRPARAMETERID		Parameter Id	20010509

Method RENDER_CHECK_BOX on class CL_RSR_WWW_DOC_MAINTENANCE has no exception.

Method RENDER_CLOSE_BUTTON Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_HTML	Value transfer	☐	Type reference (TYPE)	STRING			20010808

Method RENDER_CLOSE_BUTTON on class CL_RSR_WWW_DOC_MAINTENANCE has no exception.

Method RENDER_DELETE_BUTTON Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_HTML	Value transfer	☐	Type reference (TYPE)	STRING			20010808

Method RENDER_DELETE_BUTTON on class CL_RSR_WWW_DOC_MAINTENANCE has no exception.

Method RENDER_DELETE_PROP_BUTTON Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_PROP_CNT	Call by reference	☐	Type reference (TYPE)	I		Zeile der Eigenschaft	20020225
2	Returning	R_HTML	Value transfer	☐	Type reference (TYPE)	STRING			20020225

Method RENDER_DELETE_PROP_BUTTON on class CL_RSR_WWW_DOC_MAINTENANCE has no exception.

Method RENDER_EMPTY_COLUMN Signature

Method RENDER_EMPTY_COLUMN on class CL_RSR_WWW_DOC_MAINTENANCE has no parameter.
Method RENDER_EMPTY_COLUMN on class CL_RSR_WWW_DOC_MAINTENANCE has no exception.

Method RENDER_EMPTY_ROW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_NEW_ROW	Call by reference	☐	Type reference (TYPE)	RS_BOOL	RS_C_TRUE	Boolean	20010716

Method RENDER_EMPTY_ROW on class CL_RSR_WWW_DOC_MAINTENANCE has no exception.

Method RENDER_INPUT_FIELD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_PARAMETER	Call by reference	☐	Type reference (TYPE)	RSRPARAMETERID		Parameter Id	20010502
2	Returning	R_HIDDEN	Value transfer	☐	Type reference (TYPE)	RS_BOOL		= 'X': Feld wurde als Hidden gerendered	20031112

Method RENDER_INPUT_FIELD on class CL_RSR_WWW_DOC_MAINTENANCE has no exception.

Method RENDER_PROPERTIES Signature

Method RENDER_PROPERTIES on class CL_RSR_WWW_DOC_MAINTENANCE has no parameter.
Method RENDER_PROPERTIES on class CL_RSR_WWW_DOC_MAINTENANCE has no exception.

Method RENDER_SUBMIT_BUTTON Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_HTML	Value transfer	☐	Type reference (TYPE)	STRING			20010808

Method RENDER_SUBMIT_BUTTON on class CL_RSR_WWW_DOC_MAINTENANCE has no exception.

Method RESET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_DOCUMENT_UNLOCKED	Value transfer	☐	Type reference (TYPE)	RS_BOOL		= 'X': das bestehende Dokument wurde entsperrt	20030108

Method RESET on class CL_RSR_WWW_DOC_MAINTENANCE has no exception.

Method SAVE_DOCUMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_R_PARAMETER	Call by reference	☐	Object reference (TYPE REF TO)	CL_RSR_PARAMETER		Parameter	20010808

Method SAVE_DOCUMENT on class CL_RSR_WWW_DOC_MAINTENANCE has no exception.

Method SORT_PROPERTIES Signature

Method SORT_PROPERTIES on class CL_RSR_WWW_DOC_MAINTENANCE has no parameter.
Method SORT_PROPERTIES on class CL_RSR_WWW_DOC_MAINTENANCE has no exception.

Method START_TABLE_ROW Signature

Method START_TABLE_ROW on class CL_RSR_WWW_DOC_MAINTENANCE has no parameter.
Method START_TABLE_ROW on class CL_RSR_WWW_DOC_MAINTENANCE has no exception.

Method UNLOAD_TO_HTML Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_BODY_EXTEND	Value transfer	☐	Type reference (TYPE)	STRING		Body Tag Erweiterung	20030103

Method UNLOAD_TO_HTML on class CL_RSR_WWW_DOC_MAINTENANCE has no exception.

Method UNLOCK_DOC_AND_RESET Signature

Method UNLOCK_DOC_AND_RESET on class CL_RSR_WWW_DOC_MAINTENANCE has no parameter.
Method UNLOCK_DOC_AND_RESET on class CL_RSR_WWW_DOC_MAINTENANCE has no exception.

History

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