SAP ABAP Class CL_CRM_CENTRAL_SEARCH (Central Search)

Hierarchy

☛ WEBCUIF (Software Component) SAP Web UI Framework
   ⤷ CA-WUI-SEA (Application Component) Search
     ⤷ CRM_CENTRAL_SEARCH (Package) Central Search

Properties

Class	CL_CRM_CENTRAL_SEARCH
Short Description	Central Search
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	CRM_CENTRAL_SEARCH	Central Search
Created	20070726	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_CENTRAL_SEARCH has no interface implemented.

Friends

Class CL_CRM_CENTRAL_SEARCH has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	ALL_ATTRIBUTES	Static Attribute	Public	☐	Type reference (TYPE)	STRING	'ALL_ATTRIBUTES'	All search criteria	20080414
2	ALL_OBJECTS_VIA_SIMPLE_SEARCH	Static Attribute	Public	☐	Type reference (TYPE)	STRING	'ALL_OBJECTS_SIMPLE'	All Objects to be searched	20080414
3	BUSINESS_ROLE	Instance attribute	Protected	☐	Type reference (TYPE)	CRMT_UI_PROFILE		Business Role	20070726
4	BUSINESS_ROLE_TEXT	Instance attribute	Protected	☐	Type reference (TYPE)	CRMT_UI_DESCRIPTION30		Description	20070730
5	COOKIE_APPLICATION_NAME	Static Attribute	Protected	☐	Type reference (TYPE)	STRING	'CRM_UI_FRAME'	Application Name of Server Cookie	20080131
6	COOKIE_DATA_NAME	Static Attribute	Protected	☐	Type reference (TYPE)	STRING	'CENTRAL_SEARCH_OBJECTS'	Data Name of Server Cookie	20080131
7	COOKIE_EXPIRY_SECONDS	Static Attribute	Protected	☐	Type reference (TYPE)	I	3600	Seconds the server cookie expires	20080131
8	COOKIE_NAME	Static Attribute	Protected	☐	Type reference (TYPE)	STRING	'CENTRAL_SEARCH_OBJECTS'	Name of Server Cookie	20080131
9	GO_REQUESTED	Static Attribute	Public	☑	Type reference (TYPE)	ABAP_BOOL		Indicates if Execution has been requested	20071107
10	LISTEN_TO_WORKAREA_CHANGE	Static Attribute	Protected	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Listen to Workarea Context Change	20080521
11	MESSAGE_000_DISPLAYED	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Indicates message CRM_SAVED_SEARCH/000 was displayed	20091201
12	NAVIGATION_BAR_PROFILE	Instance attribute	Protected	☐	Type reference (TYPE)	STRING		Navigation Bar Profile of Business Role	20070726
13	REQUEST_IS_RUNNING	Static Attribute	Protected	☐	Type reference (TYPE)	ABAP_BOOL		Indicates if central search is in progress	20070809
14	ROUNDTRIP_HANDLER	Static Attribute	Private	☐	Object reference (TYPE REF TO)	LCL_ROUNDTRIP_HANDLER		Object to register on end of round trip	20071107
15	SEARCH_OBJECTS	Instance attribute	Private	☐	Type reference (TYPE)	LT_SEARCH_OBJECTS		Central Search Objects	20070726
16	UI_OBJECT_ACTION	Static Attribute	Public	☑	Type reference (TYPE)	CRMT_UI_ACTIONS		UI Object Action called during Navigation	20080131
17	UI_OBJECT_ACTION_SIMPLE_SEARCH	Static Attribute	Public	☐	Type reference (TYPE)	CRMT_UI_ACTIONS	'H'	UI Action for Simple Search	20080411
18	UI_OBJECT_TYPE	Static Attribute	Public	☑	Type reference (TYPE)	BSP_DLC_OBJECT_TYPE		UI Object Type called during Navigation	20080131
19	WORKAREA_CHANGED	Static Attribute	Protected	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Indicates if Workarea Content Change	20080521

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CLASS_CONSTRUCTOR	Static method	Public	Constructor		20070809
2	CLEAR_CACHE	Static method	Public	Method	Method clears the Central Search Objects Cache	20080131
3	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	20070726
4	GET_AUTO_NAVIGATION_REQUESTED	Static method	Public	Method	Tell if Autonavigation Requested if single hit search result	20070731
5	GET_MAX_HITS	Static method	Public	Method	Returns Maximum Hits Parameter for Searches	20070731
6	GET_SEARCH_OBJECTS	Instance method	Public	Method	Not implemented:Returns Search Objects as Objects	20070730
7	GET_SEARCH_OBJECTS_AS_TABLE	Static method	Public	Method	Returns Search Objects (and Criteria) as Internal Table	20070731
8	GET_SEARCH_OBJECTS_AS_TABLE_	Instance method	Public	Method	Returns Search Objects (and Criteria) as Internal Table	20070731
9	GET_UI_TYPE	Static method	Public	Method	Tells how many search dropdowns are requested	20070731
10	IS_REQUEST_RUNNING	Static method	Public	Method	Get and set if central search request is being processed	20070809
11	ON_BETWEEN_CONTEXT_CHANGE	Static method	Private	Event handling method	Working Area Context Changed	20080521
12	ON_END_OF_NAVIGATION	Static method	Public	Event handling method	Reset request is running on end of navigation	20070809
13	SPLIT_TEXT	Static method	Public	Method	Split text in parts with a maximum length	20091201

Events

Class CL_CRM_CENTRAL_SEARCH has no event.

Types

Class CL_CRM_CENTRAL_SEARCH has no local type.

Method Signatures

Method CLASS_CONSTRUCTOR Signature

Method CLASS_CONSTRUCTOR on class CL_CRM_CENTRAL_SEARCH has no parameter.
Method CLASS_CONSTRUCTOR on class CL_CRM_CENTRAL_SEARCH has no exception.

Method CLEAR_CACHE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_BUSINESS_ROLE	Call by reference	☐	Type reference (TYPE)	CRMT_UI_PROFILE		Business Role	20080131
2	Importing	IV_LANGUAGE	Call by reference	☐	Attribute reference (LIKE)	SY-LANGU		Language Key of Current Text Environment	20080131
3	Returning	RV_SUCCESS	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20080131

Method CLEAR_CACHE on class CL_CRM_CENTRAL_SEARCH has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_BUSINESS_ROLE	Call by reference	☑	Type reference (TYPE)	CRMT_UI_PROFILE		Business Role	20070726
2	Importing	IV_MESSAGE_SERVICE	Call by reference	☑	Object reference (TYPE REF TO)	CL_BSP_WD_MESSAGE_SERVICE		Message Service to Indicate Problems	20091201

Method CONSTRUCTOR on class CL_CRM_CENTRAL_SEARCH has no exception.

Method GET_AUTO_NAVIGATION_REQUESTED Signature

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

Method GET_AUTO_NAVIGATION_REQUESTED on class CL_CRM_CENTRAL_SEARCH has no exception.

Method GET_MAX_HITS Signature

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

Method GET_MAX_HITS on class CL_CRM_CENTRAL_SEARCH has no exception.

Method GET_SEARCH_OBJECTS Signature

Method GET_SEARCH_OBJECTS on class CL_CRM_CENTRAL_SEARCH has no parameter.
Method GET_SEARCH_OBJECTS on class CL_CRM_CENTRAL_SEARCH has no exception.

Method GET_SEARCH_OBJECTS_AS_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_BUSINESS_ROLES	Call by reference	☑	Type reference (TYPE)	CRMT_UI_PROFILE_TAB		List of business roles	20070731
2	Importing	IV_MESSAGE_SERVICE	Call by reference	☑	Object reference (TYPE REF TO)	CL_BSP_WD_MESSAGE_SERVICE			20091201
3	Returning	RV_SEARCH_OBJECTS_AS_TABLE	Value transfer	☐	Type reference (TYPE)	CRMT_CENTRAL_SEARCH_OBJECTS		Central Search Objects	20070731

Method GET_SEARCH_OBJECTS_AS_TABLE on class CL_CRM_CENTRAL_SEARCH has no exception.

Method GET_SEARCH_OBJECTS_AS_TABLE_ Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_SEARCH_OBJECTS_AS_TABLE	Value transfer	☐	Type reference (TYPE)	CRMT_CENTRAL_SEARCH_OBJECTS		Central Search Criteria	20070731

Method GET_SEARCH_OBJECTS_AS_TABLE_ on class CL_CRM_CENTRAL_SEARCH has no exception.

Method GET_UI_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_BUSINESS_ROLES	Call by reference	☑	Type reference (TYPE)	CRMT_UI_PROFILE_TAB		List of business roles	20070731
2	Returning	RV_UI_TYPE	Value transfer	☐	Type reference (TYPE)	STRING			20070731

Method GET_UI_TYPE on class CL_CRM_CENTRAL_SEARCH has no exception.

Method IS_REQUEST_RUNNING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_GO_REQUESTED	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE		20071107
2	Importing	IV_REQUEST_IS_RUNNING	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL			20070809
3	Importing	IV_UI_OBJECT_ACTION	Call by reference	☐	Type reference (TYPE)	CRMT_UI_ACTIONS	''	UI Action	20080131
4	Importing	IV_UI_OBJECT_TYPE	Call by reference	☐	Type reference (TYPE)	BSP_DLC_OBJECT_TYPE	''	UI Object Type	20080131
5	Returning	RV_REQUEST_IS_RUNNING	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20070809

Method IS_REQUEST_RUNNING on class CL_CRM_CENTRAL_SEARCH has no exception.

Method ON_BETWEEN_CONTEXT_CHANGE Signature

Method ON_BETWEEN_CONTEXT_CHANGE on class CL_CRM_CENTRAL_SEARCH has no parameter.
Method ON_BETWEEN_CONTEXT_CHANGE on class CL_CRM_CENTRAL_SEARCH has no exception.

Method ON_END_OF_NAVIGATION Signature

Method ON_END_OF_NAVIGATION on class CL_CRM_CENTRAL_SEARCH has no parameter.
Method ON_END_OF_NAVIGATION on class CL_CRM_CENTRAL_SEARCH has no exception.

Method SPLIT_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CV_TEXT1	Call by reference	☐	Type reference (TYPE)	STRING			20091201
2	Changing	CV_TEXT2	Call by reference	☑	Type reference (TYPE)	STRING			20091201
3	Changing	CV_TEXT3	Call by reference	☑	Type reference (TYPE)	STRING			20091201
4	Changing	CV_TEXT4	Call by reference	☑	Type reference (TYPE)	STRING			20091201
5	Importing	IV_PART_LENGTH	Call by reference	☐	Type reference (TYPE)	I			20091201
6	Importing	IV_TEXT	Call by reference	☐	Type reference (TYPE)	STRING			20091201

Method SPLIT_TEXT on class CL_CRM_CENTRAL_SEARCH has no exception.

History

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