SAP ABAP Class CL_CRM_UI_PARAMETER_UTIL (Parameter access)

Hierarchy

☛ WEBCUIF (Software Component) SAP Web UI Framework
   ⤷ CA-WUI-APF (Application Component) Application Frame
     ⤷ CRM_BSP_UI_FRAME_CORE (Package) Application Frame DDIC, Services and Utilities

Properties

Class	CL_CRM_UI_PARAMETER_UTIL
Short Description	Parameter access
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	CRM_BSP_UI_FRAME_CORE	Application Frame DDIC, Services and Utilities
Created	20060612	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)

Interfaces

Class CL_CRM_UI_PARAMETER_UTIL has no interface implemented.

Friends

Class CL_CRM_UI_PARAMETER_UTIL has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	ALLSEARCHES_SVDSRCH_PARAM_DFLT	Constant	Public	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Saved searcges to be displayed in central search by default	20090930
2	ALLSEARCHES_SVDSRCH_PARAM_ID	Constant	Public	☐	Type reference (TYPE)	STRING	'ALLSEARCHES_SVDSRCH'	Saved searches to be displayed in central search menu	20090930
3	CNTRLSEARCH_UI_TYPE_PARAM_DFLT	Constant	Public	☐	Type reference (TYPE)	STRING	'3'	UI Type Parameter Default	20070801
4	CNTRLSEARCH_UI_TYPE_PARAM_ID	Constant	Public	☐	Type reference (TYPE)	STRING	'CNTRLSEARCH_UI_TYPE'	UI Type Parameter Id	20070801
5	EXPORT_DISABLE_ID	Constant	Public	☐	Type reference (TYPE)	STRING	'EXPORT_DISABLE'	Disable Export to Spreadsheet	20081218
6	GC_ADH_VERSION	Constant	Public	☐	Type reference (TYPE)	STRING	'ADH_CRM700_VERSION'	Delta handling old version	20120829
7	GC_DEFAULT_SEARCH	Constant	Public	☐	Type reference (TYPE)	STRING	'DEFAULT_SEARCH'	Functional parameter default search	20100224
8	GC_ENABLE_FTG_USAGE_ALL	Constant	Public	☐	Type reference (TYPE)	STRING	'ALL'	Usage parameter value	20080324
9	GC_ENABLE_FTG_USAGE_BOTH	Constant	Public	☐	Type reference (TYPE)	STRING	'BOTH'	Usage parameter value	20080227
10	GC_ENABLE_FTG_USAGE_DEFAULT	Constant	Public	☐	Type reference (TYPE)	STRING	'ALL'	Cellerator usage to enable Flex Table Graphics	20080227
11	GC_ENABLE_FTG_USAGE_ID	Constant	Public	☐	Type reference (TYPE)	STRING	'ENABLE_FTG_USAGE'	Cellerator usage to enable Flex Table Graphics	20080227
12	GC_ENABLE_FTG_USAGE_NONE	Constant	Public	☐	Type reference (TYPE)	STRING	'NONE'	Usage parameter value	20080227
13	GC_MESS_AREA_TYPE_ANCHOR	Constant	Public	☐	Type reference (TYPE)	STRING	'ANCHOR'	Message area type value	20080724
14	GC_MESS_AREA_TYPE_INPLWIND	Constant	Public	☐	Type reference (TYPE)	STRING	'INPLACEWINDOW'	Message area type value	20080724
15	GT_PARAMETERS	Instance attribute	Private	☐	Type reference (TYPE)	TY_PARAMETER_TAB			20060612
16	GV_SELF	Static Attribute	Protected	☐	Object reference (TYPE REF TO)	CL_CRM_UI_PARAMETER_UTIL		Parameter access	20060612
17	MESSAGE_AREA_LINES_DEF	Constant	Public	☐	Type reference (TYPE)	I	3	Max number of lines in message area	20071126
18	MESSAGE_AREA_LINES_ID	Constant	Public	☐	Type reference (TYPE)	STRING	'MESSAGE_AREA_LINES'	Max number of lines in message area parameter id	20071126
19	MESSAGE_AREA_TYPE_ID	Constant	Public	☐	Type reference (TYPE)	STRING	'MESSAGE_AREA_TYPE'	Type of	20080724
20	SAVED_SEARCH_POPUP_DEFAULT	Constant	Public	☐	Type reference (TYPE)	STRING	'OFF'	Saved Search Popup Selector Default	20091102
21	SAVED_SEARCH_POPUP_PARAM_ID	Constant	Public	☐	Type reference (TYPE)	STRING	'SAVED_SEARCH_POPUP'	Saved Search Popup Selector Parameter Id	20091102
22	SEARCH_AUTONAV_PARAM_DEFAULT	Constant	Public	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Search Automatic Navigation Parameter Default	20070731
23	SEARCH_AUTONAV_PARAM_ID	Constant	Public	☐	Type reference (TYPE)	STRING	'SEARCH_AUTONAV'	Search Automatic Navigation Parameter Id	20070731
24	SEARCH_MAX_HITS_PARAM_DEFAULT	Constant	Public	☐	Type reference (TYPE)	I	100	Search Max Hits Parameter Default	20070731
25	SEARCH_MAX_HITS_PARAM_ID	Constant	Public	☐	Type reference (TYPE)	STRING	'SEARCH_MAX_HITS'	Search Max Hits Parameter Id	20070731
26	SEARCH_MENU_EXPIRY_DEFAULT	Constant	Public	☐	Type reference (TYPE)	I	3600	Central Search Menu Expiry Seconds	20090206
27	SEARCH_MENU_EXPIRY_PARAM_ID	Constant	Public	☐	Type reference (TYPE)	STRING	'SEARCH_MENU_EXPIRY'	Central search Expiry Seconds Parameter	20090206
28	WC_LINK_ORDER_ALPHA	Constant	Public	☐	Type reference (TYPE)	STRING	'ALPHA'	Alphabetical Work Center Link Order	20080204
29	WC_LINK_ORDER_ID	Constant	Public	☐	Type reference (TYPE)	STRING	'WC_LINK_ORDER'	Work Center Link Order	20080204

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20060612
2	GET_ADH_VERSION	Static method	Public	Method	Return the value of the parameter	20120829
3	GET_ALLSEARCHES_SVDSRCH	Static method	Public	Method	Returns if saved search entry to be displayed in menu	20090930
4	GET_CNTRLSEARCH_UI_TYPE	Static method	Public	Method	Returns default Value for UI Type Parameter of Cntral Search	20070801
5	GET_CRM_UI_PARAMETER_VALUE	Static method	Public	Method	Returns a CRM UI PROFILE PARAMETER VALUE.	20090317
6	GET_DEFAULT_SEARCH	Static method	Public	Method	Return value of parameter DEFAULT_SEARCH	20100224
7	GET_EXPORT_DISABLE	Static method	Public	Method	Returns the setting for disabling Export to Spreadsheet	20081218
8	GET_FTG_USAGE	Static method	Public	Method	Returns the cellerator usage considering the default value.	20080227
9	GET_INSTANCE	Static method	Public	Method		20060612
10	GET_MESSAGE_AREA_LINES	Static method	Public	Method	Returns the max. number of visible lines of the message area	20071126
11	GET_PARAMETER	Instance method	Public	Method		20060612
12	GET_SAVED_SEARCH_POPUP	Static method	Public	Method	Returns Selector Template for Saved Searches in Popups	20091102
13	GET_SEARCH_AUTONAV	Static method	Public	Method	Returns default Value for Automatic Navigation Parameter	20070731
14	GET_SEARCH_MAX_HITS	Static method	Public	Method	Returns default Value for Max Hits Parameter of a Search	20070731
15	GET_SEARCH_MENU_EXPIRY_SECONDS	Static method	Public	Method	Returns default Value for Max Hits Parameter of a Search	20090206
16	GET_WC_LINK_ORDER	Static method	Public	Method	Returns the order of Links on work center pages	20080204
17	IS_PARAMETER_ASSIGNED	Instance method	Public	Method	Returns true if the parameter is used in the Func. Profile	20120308
18	TO_BOOLEAN	Static method	Public	Method	Checks if entriy	20070810

Events

Class CL_CRM_UI_PARAMETER_UTIL has no event.

Types

Class CL_CRM_UI_PARAMETER_UTIL has no local type.

Method Signatures

Method CONSTRUCTOR Signature

Method CONSTRUCTOR on class CL_CRM_UI_PARAMETER_UTIL has no parameter.
Method CONSTRUCTOR on class CL_CRM_UI_PARAMETER_UTIL has no exception.

Method GET_ADH_VERSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_RESULT	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		Value of parameter ADH_CRM700_VERSION	20120829

Method GET_ADH_VERSION on class CL_CRM_UI_PARAMETER_UTIL has no exception.

Method GET_ALLSEARCHES_SVDSRCH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_ALLSEARCHES_SVDSRCH	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20090930

Method GET_ALLSEARCHES_SVDSRCH on class CL_CRM_UI_PARAMETER_UTIL has no exception.

Method GET_CNTRLSEARCH_UI_TYPE Signature

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

Method GET_CNTRLSEARCH_UI_TYPE on class CL_CRM_UI_PARAMETER_UTIL has no exception.

Method GET_CRM_UI_PARAMETER_VALUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IN_NAME	Call by reference	☐	Type reference (TYPE)	STRING		CRM UI Parameter NAME	20090317
2	Returning	OUT_VALUE	Value transfer	☐	Type reference (TYPE)	STRING		CRM UI Parameter VALUE	20090318

Method GET_CRM_UI_PARAMETER_VALUE on class CL_CRM_UI_PARAMETER_UTIL has no exception.

Method GET_DEFAULT_SEARCH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_RESULT	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		Value of parameter default search	20100224

Method GET_DEFAULT_SEARCH on class CL_CRM_UI_PARAMETER_UTIL has no exception.

Method GET_EXPORT_DISABLE Signature

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

Method GET_EXPORT_DISABLE on class CL_CRM_UI_PARAMETER_UTIL has no exception.

Method GET_FTG_USAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_RESULT_STRING	Call by reference	☐	Type reference (TYPE)	STRING			20080227
2	Exporting	EV_USAGE_ASSIGNMENTBLOCK	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20080227
3	Exporting	EV_USAGE_SEARCHRESULT	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20080227

Method GET_FTG_USAGE on class CL_CRM_UI_PARAMETER_UTIL has no exception.

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_RESULT	Value transfer	☐	Object reference (TYPE REF TO)	CL_CRM_UI_PARAMETER_UTIL		Parameter access	20060612

Method GET_INSTANCE on class CL_CRM_UI_PARAMETER_UTIL has no exception.

Method GET_MESSAGE_AREA_LINES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_RESULT	Value transfer	☐	Type reference (TYPE)	I		maximum lines for the message area	20071126

Method GET_MESSAGE_AREA_LINES on class CL_CRM_UI_PARAMETER_UTIL has no exception.

Method GET_PARAMETER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_NAME	Call by reference	☐	Type reference (TYPE)	SIMPLE			20060612
2	Returning	RV_RESULT	Value transfer	☐	Type reference (TYPE)	STRING			20060612

Method GET_PARAMETER on class CL_CRM_UI_PARAMETER_UTIL has no exception.

Method GET_SAVED_SEARCH_POPUP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_SAVED_SEARCH_POPUP	Value transfer	☐	Type reference (TYPE)	STRING		Saved Search Selector	20091102

Method GET_SAVED_SEARCH_POPUP on class CL_CRM_UI_PARAMETER_UTIL has no exception.

Method GET_SEARCH_AUTONAV Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_SEARCH_AUTONAV	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20070731

Method GET_SEARCH_AUTONAV on class CL_CRM_UI_PARAMETER_UTIL has no exception.

Method GET_SEARCH_MAX_HITS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_SEARCH_MAX_HITS	Value transfer	☐	Type reference (TYPE)	I			20070731

Method GET_SEARCH_MAX_HITS on class CL_CRM_UI_PARAMETER_UTIL has no exception.

Method GET_SEARCH_MENU_EXPIRY_SECONDS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_SEARCH_MENU_EXPIRY_SEC	Value transfer	☐	Type reference (TYPE)	I			20090206

Method GET_SEARCH_MENU_EXPIRY_SECONDS on class CL_CRM_UI_PARAMETER_UTIL has no exception.

Method GET_WC_LINK_ORDER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_RESULT	Value transfer	☐	Type reference (TYPE)	STRING		Work Center Link Order	20080204

Method GET_WC_LINK_ORDER on class CL_CRM_UI_PARAMETER_UTIL has no exception.

Method IS_PARAMETER_ASSIGNED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_NAME	Call by reference	☐	Type reference (TYPE)	SIMPLE			20120308
2	Returning	RV_RESULT	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20120308

Method IS_PARAMETER_ASSIGNED on class CL_CRM_UI_PARAMETER_UTIL has no exception.

Method TO_BOOLEAN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_TEXT	Call by reference	☐	Type reference (TYPE)	STRING			20070810
2	Returning	RV_BOOLEAN	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20070810

Method TO_BOOLEAN on class CL_CRM_UI_PARAMETER_UTIL has no exception.

History

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