SAP ABAP Class CL_BSPWD_HELP_F1 (Controller Class for CRM_BSP_F1_HELP)

Hierarchy

☛ WEBCUIF (Software Component) SAP Web UI Framework
   ⤷ CA-WUI-UI (Application Component) User Interface
     ⤷ CRM_BSP_WD_APPL_BASICS (Package) Basic Application Objects

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_BSPWD_HELP	Controller Class for CRM_BSP_HELP	20071106

Properties

Class	CL_BSPWD_HELP_F1
Short Description	Controller Class for CRM_BSP_F1_HELP
Super Class	CL_BSPWD_HELP	Controller Class for CRM_BSP_HELP
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	CRM_BSP_WD_APPL_BASICS	Basic Application Objects
Created	20071106	SAP
Last change	20100303	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

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

Interfaces

Class CL_BSPWD_HELP_F1 has no interface implemented.

Friends

Class CL_BSPWD_HELP_F1 has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CONTENT_DATA	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20071106
2	CONTENT_URL	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20071106
3	C_KW_DOCTYPE	Constant	Protected	☐	Type reference (TYPE)	STRING	'kw'		20071106
4	C_MSGLT_DOCTYPE	Constant	Protected	☐	Type reference (TYPE)	STRING	'msglt'		20071106
5	C_R3_DOCTYPE	Constant	Protected	☐	Type reference (TYPE)	STRING	'r3'		20071106
6	N_KW_CLASS	Constant	Protected	☐	Type reference (TYPE)	STRING	'class'		20071106
7	N_KW_DOCTYPE	Constant	Protected	☐	Type reference (TYPE)	STRING	'doctype'		20071106
8	N_KW_LANGUAGE	Constant	Protected	☐	Type reference (TYPE)	STRING	'language'		20071106
9	N_KW_LOIO	Constant	Protected	☐	Type reference (TYPE)	STRING	'loio'		20071106
10	N_KW_STRUC	Constant	Protected	☐	Type reference (TYPE)	STRING	'struc'		20071106
11	N_MSGLT_DOCTYPE	Constant	Protected	☐	Type reference (TYPE)	STRING	'doctype'		20071106
12	N_MSGLT_HANDLE	Constant	Protected	☐	Type reference (TYPE)	STRING	'handle'		20071120
13	N_MSGLT_LANGUAGE	Constant	Protected	☐	Type reference (TYPE)	STRING	'language'		20071106
14	N_MSGLT_MSGID	Constant	Protected	☐	Type reference (TYPE)	STRING	'msgid'		20071106
15	N_MSGLT_MSGNO	Constant	Protected	☐	Type reference (TYPE)	STRING	'msgno'		20071106
16	N_MSGLT_MSGV1	Constant	Protected	☐	Type reference (TYPE)	STRING	'msgv1'		20071106
17	N_MSGLT_MSGV2	Constant	Protected	☐	Type reference (TYPE)	STRING	'msgv2'		20071106
18	N_MSGLT_MSGV3	Constant	Protected	☐	Type reference (TYPE)	STRING	'msgv3'		20071106
19	N_MSGLT_MSGV4	Constant	Private	☐	Type reference (TYPE)	STRING	'msgv4'		20071106
20	N_R3_DOCTYPE	Constant	Protected	☐	Type reference (TYPE)	STRING	'doctype'		20071106
21	N_R3_ID	Constant	Protected	☐	Type reference (TYPE)	STRING	'id'		20071106
22	N_R3_LANGUAGE	Constant	Protected	☐	Type reference (TYPE)	STRING	'language'		20071106

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	GET_CONTENT_DATA	Instance method	Protected	Method		20071106
2	GET_CONTENT_DATA_MSGLT	Static method	Protected	Method	Message long text	20071106
3	GET_CONTENT_DATA_R3_DOCU	Static method	Protected	Method	R/3 Docu	20071106
4	GET_CONTENT_URL	Instance method	Protected	Method		20071106
5	GET_CONTENT_URL_KW	Static method	Protected	Method	KW Link	20071106
6	GET_HTML_R3_DOCU	Static method	Protected	Method	R/3 Docu	20071106
7	GET_HTML_R3_DOCU_INTERNAL	Static method	Private	Method	R/3 Docu (Copy of CRM_DOCU_GET_HTML)	20071106
8	GET_LINK_PARAMETER_KW	Static method	Public	Method	Delivers Parameters for KW Link	20071106
9	GET_LINK_PARAMETER_MSG	Static method	Public	Method	Delivers Parameters for Message Link	20071106
10	GET_LINK_REFERENCE_KW	Static method	Public	Method	Delivers Target URL for KW Link	20071106
11	GET_LINK_REFERENCE_MSGLT	Static method	Public	Method	Delivers Target URL for Message Long Text	20071106
12	GET_LINK_REFERENCE_R3_DOCU	Static method	Public	Method	Delivers Target URL for R/3 Docu Link	20071106
13	JAVASCRIPT_SHOW_HELP	Static method	Protected	Method	JavaScript Command for Opening F1 Help Windos	20071106
14	SET_CONTENT_DATA	Instance method	Protected	Method		20071106
15	SET_CONTENT_URL	Instance method	Protected	Method		20071106

Events

Class CL_BSPWD_HELP_F1 has no event.

Types

Class CL_BSPWD_HELP_F1 has no local type.

Method Signatures

Method GET_CONTENT_DATA Signature

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

Method GET_CONTENT_DATA on class CL_BSPWD_HELP_F1 has no exception.

Method GET_CONTENT_DATA_MSGLT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	CONTENT	Value transfer	☐	Type reference (TYPE)	STRING			20071106
2	Importing	HANDLE	Call by reference	☑	Type reference (TYPE)	BALMNR		Application Log: Log Handle	20071120
3	Importing	LANGUAGE	Call by reference	☑	Type reference (TYPE)	STRING			20071106
4	Importing	MSGID	Call by reference	☐	Type reference (TYPE)	STRING			20071106
5	Importing	MSGNO	Call by reference	☐	Type reference (TYPE)	STRING			20071106
6	Importing	MSGV1	Call by reference	☑	Type reference (TYPE)	STRING			20071106
7	Importing	MSGV2	Call by reference	☑	Type reference (TYPE)	STRING			20071106
8	Importing	MSGV3	Call by reference	☑	Type reference (TYPE)	STRING			20071106
9	Importing	MSGV4	Call by reference	☑	Type reference (TYPE)	STRING			20071106
10	Importing	RUNTIME	Call by reference	☐	Object reference (TYPE REF TO)	IF_BSP_RUNTIME		Business Server Page (BSP) Runtime	20071106

Method GET_CONTENT_DATA_MSGLT on class CL_BSPWD_HELP_F1 has no exception.

Method GET_CONTENT_DATA_R3_DOCU Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	CONTENT	Value transfer	☐	Type reference (TYPE)	STRING			20071106
2	Importing	HANDLE	Call by reference	☑	Type reference (TYPE)	BALMNR		Application log: Internal message serial number	20071120
3	Importing	ID	Call by reference	☐	Type reference (TYPE)	STRING			20071106
4	Importing	LANGUAGE	Call by reference	☑	Type reference (TYPE)	STRING			20071106
5	Importing	PARAMETERS	Call by reference	☑	Type reference (TYPE)	CNHT_QUERY_TABLE			20071106
6	Importing	RUNTIME	Call by reference	☐	Object reference (TYPE REF TO)	IF_BSP_RUNTIME		Business Server Page (BSP) Runtime	20071106

Method GET_CONTENT_DATA_R3_DOCU on class CL_BSPWD_HELP_F1 has no exception.

Method GET_CONTENT_URL Signature

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

Method GET_CONTENT_URL on class CL_BSPWD_HELP_F1 has no exception.

Method GET_CONTENT_URL_KW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CLASS	Call by reference	☐	Type reference (TYPE)	STRING			20071106
2	Importing	LANGUAGE	Call by reference	☑	Type reference (TYPE)	STRING			20071106
3	Importing	LOIO	Call by reference	☐	Type reference (TYPE)	STRING			20071106
4	Importing	STRUC	Call by reference	☑	Type reference (TYPE)	STRING			20071106
5	Returning	URL	Value transfer	☐	Type reference (TYPE)	STRING			20071106

Method GET_CONTENT_URL_KW on class CL_BSPWD_HELP_F1 has no exception.

Method GET_HTML_R3_DOCU Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	DOCUMENT	Value transfer	☐	Type reference (TYPE)	STRING			20071106
2	Importing	HANDLE	Call by reference	☑	Type reference (TYPE)	BALMNR		Application Log: Log Handle	20071120
3	Importing	ID	Call by reference	☐	Type reference (TYPE)	STRING			20071106
4	Importing	LANGUAGE	Call by reference	☑	Type reference (TYPE)	STRING			20071106
5	Importing	PARAMETERS	Call by reference	☑	Type reference (TYPE)	CNHT_QUERY_TABLE			20071106

#	Exception	Resumable	Description	Created on
1	NOT_FOUND	☐		20071106

Method GET_HTML_R3_DOCU_INTERNAL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_HTMLLINES	Call by reference	☐	Type reference (TYPE)	HTMLTABLE		Table with HTMLLINE	20071106
2	Exporting	EV_TITLE	Call by reference	☐	Type reference (TYPE)	STRING			20071106
3	Importing	IT_PARAM	Call by reference	☑	Type reference (TYPE)	CNHT_QUERY_TABLE			20071106
4	Importing	IV_HANDLE	Call by reference	☑	Type reference (TYPE)	BALMNR			20071120
5	Importing	IV_LANGU	Value transfer	☑	Type reference (TYPE)	SYLANGU		SAP System, Current Language	20071106
6	Importing	IV_LINK	Value transfer	☑	Type reference (TYPE)	C			20071106
7	Importing	IV_NAME	Value transfer	☐	Type reference (TYPE)	STRING			20071106
8	Importing	IV_NO_HEADER	Value transfer	☑	Type reference (TYPE)	BOOLE_D		Data Element for Domain BOOLE: TRUE (="X") and FALSE (=" ")	20071106
9	Importing	IV_TITLE	Value transfer	☑	Type reference (TYPE)	STRING			20071106

#	Exception	Resumable	Description	Created on
1	NOT_FOUND	☐		20071106
2	PARAM_ERROR	☐		20071106

Method GET_LINK_PARAMETER_KW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CLASS	Call by reference	☐	Type reference (TYPE)	SDOK_CLASS		Document Class	20071106
2	Importing	DISPLAY_IN_NEW_WINDOW	Call by reference	☐	Type reference (TYPE)	CHAR1	'X'	Single-Character Indicator	20071106
3	Importing	GET_DIRECT_REFERENCE	Call by reference	☐	Type reference (TYPE)	CHAR1	SPACE	Deliver KW URL Directly	20071106
4	Importing	LANGUAGE	Call by reference	☑	Type reference (TYPE)	SY-LANGU		SAP System, Current Language	20071106
5	Importing	LOIO	Call by reference	☐	Type reference (TYPE)	SDOK_DOCID		ID for Documents and Relationships	20071106
6	Exporting	REFERENCE	Call by reference	☐	Type reference (TYPE)	STRING			20071106
7	Importing	RUNTIME	Call by reference	☐	Object reference (TYPE REF TO)	IF_BSP_RUNTIME		Business Server Page (BSP) Runtime	20071106
8	Importing	STRUC	Call by reference	☑	Type reference (TYPE)	SDOK_DOCID		ID for Documents and Relationships	20071106
9	Exporting	TEXT	Call by reference	☐	Type reference (TYPE)	STRING			20071106

Method GET_LINK_PARAMETER_KW on class CL_BSPWD_HELP_F1 has no exception.

Method GET_LINK_PARAMETER_MSG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DISPLAY_IN_NEW_WINDOW	Call by reference	☐	Type reference (TYPE)	CHAR1	'X'	Single-Character Indicator	20071106
2	Importing	LANGUAGE	Call by reference	☑	Type reference (TYPE)	SY-LANGU		SAP System, Current Language	20071106
3	Importing	MSGID	Call by reference	☐	Type reference (TYPE)	STRING			20071106
4	Importing	MSGNO	Call by reference	☐	Type reference (TYPE)	STRING			20071106
5	Importing	MSGV1	Call by reference	☑	Type reference (TYPE)	STRING			20071106
6	Importing	MSGV2	Call by reference	☑	Type reference (TYPE)	STRING			20071106
7	Importing	MSGV3	Call by reference	☑	Type reference (TYPE)	STRING			20071106
8	Importing	MSGV4	Call by reference	☑	Type reference (TYPE)	STRING			20071106
9	Exporting	REFERENCE	Call by reference	☐	Type reference (TYPE)	STRING			20071106
10	Importing	RUNTIME	Call by reference	☐	Object reference (TYPE REF TO)	IF_BSP_RUNTIME		Business Server Page (BSP) Runtime	20071106
11	Exporting	TEXT	Call by reference	☐	Type reference (TYPE)	STRING			20071106

Method GET_LINK_PARAMETER_MSG on class CL_BSPWD_HELP_F1 has no exception.

Method GET_LINK_REFERENCE_KW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CLASS	Call by reference	☐	Type reference (TYPE)	SDOK_CLASS		Document Class	20071106
2	Importing	DISPLAY_IN_NEW_WINDOW	Call by reference	☐	Type reference (TYPE)	CHAR1	'X'	New Window for Display	20071106
3	Importing	GET_DIRECT_REFERENCE	Call by reference	☐	Type reference (TYPE)	CHAR1	SPACE	Deliver KW URL Directly	20071106
4	Importing	LANGUAGE	Call by reference	☑	Type reference (TYPE)	SY-LANGU		SAP System, Current Language	20071106
5	Importing	LOIO	Call by reference	☐	Type reference (TYPE)	SDOK_DOCID		ID for Documents and Relationships	20071106
6	Returning	REFERENCE	Value transfer	☐	Type reference (TYPE)	STRING			20071106
7	Importing	RUNTIME	Call by reference	☐	Object reference (TYPE REF TO)	IF_BSP_RUNTIME		Business Server Page (BSP) Runtime	20071106
8	Importing	STRUC	Call by reference	☑	Type reference (TYPE)	SDOK_DOCID		ID for Documents and Relationships	20071106

Method GET_LINK_REFERENCE_KW on class CL_BSPWD_HELP_F1 has no exception.

Method GET_LINK_REFERENCE_MSGLT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DISPLAY_IN_NEW_WINDOW	Call by reference	☐	Type reference (TYPE)	CHAR1	'X'	Single-Character Indicator	20071106
2	Importing	LANGUAGE	Call by reference	☑	Type reference (TYPE)	SY-LANGU		SAP System, Current Language	20071106
3	Importing	MSGID	Call by reference	☐	Type reference (TYPE)	STRING			20071106
4	Importing	MSGNO	Call by reference	☐	Type reference (TYPE)	STRING			20071106
5	Importing	MSGV1	Call by reference	☑	Type reference (TYPE)	STRING			20071106
6	Importing	MSGV2	Call by reference	☑	Type reference (TYPE)	STRING			20071106
7	Importing	MSGV3	Call by reference	☑	Type reference (TYPE)	STRING			20071106
8	Importing	MSGV4	Call by reference	☑	Type reference (TYPE)	STRING			20071106
9	Returning	REFERENCE	Value transfer	☐	Type reference (TYPE)	STRING			20071106
10	Importing	RUNTIME	Call by reference	☐	Object reference (TYPE REF TO)	IF_BSP_RUNTIME		Business Server Page (BSP) Runtime	20071106

Method GET_LINK_REFERENCE_MSGLT on class CL_BSPWD_HELP_F1 has no exception.

Method GET_LINK_REFERENCE_R3_DOCU Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DISPLAY_IN_NEW_WINDOW	Call by reference	☐	Type reference (TYPE)	CHAR1	'X'	Single-Character Indicator	20071106
2	Importing	ID	Call by reference	☐	Type reference (TYPE)	STRING			20071106
3	Importing	LANGUAGE	Call by reference	☑	Type reference (TYPE)	SY-LANGU		SAP System, Current Language	20071106
4	Returning	REFERENCE	Value transfer	☐	Type reference (TYPE)	STRING			20071106
5	Importing	RUNTIME	Call by reference	☐	Object reference (TYPE REF TO)	IF_BSP_RUNTIME		Business Server Page (BSP) Runtime	20071106

Method GET_LINK_REFERENCE_R3_DOCU on class CL_BSPWD_HELP_F1 has no exception.

Method JAVASCRIPT_SHOW_HELP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	REFERENCE	Value transfer	☐	Type reference (TYPE)	STRING			20071106
2	Importing	URL	Call by reference	☐	Type reference (TYPE)	STRING			20071106

Method JAVASCRIPT_SHOW_HELP on class CL_BSPWD_HELP_F1 has no exception.

Method SET_CONTENT_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CONTENT	Call by reference	☐	Type reference (TYPE)	STRING			20071106

Method SET_CONTENT_DATA on class CL_BSPWD_HELP_F1 has no exception.

Method SET_CONTENT_URL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CONTENT	Call by reference	☐	Type reference (TYPE)	STRING			20071106

Method SET_CONTENT_URL on class CL_BSPWD_HELP_F1 has no exception.

History

Last changed by/on	SAP	20100303
SAP Release Created in	700