SAP ABAP Class CL_ESH_SE_FREESTYLE_ANALYSIS (Analysis Tools for Freestyle Search)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-EIM-ESH (Application Component) NetWeaver Enterprise Search
     ⤷ S_ESH_ENG_SEARCH (Package) Search (internal)

Properties

Class	CL_ESH_SE_FREESTYLE_ANALYSIS
Short Description	Analysis Tools for Freestyle Search
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	S_ESH_ENG_SEARCH	Search (internal)
Created	20090617	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_ESH_SE_FREESTYLE_ANALYSIS has no interface implemented.

Friends

Class CL_ESH_SE_FREESTYLE_ANALYSIS has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MR_REF_REQ_HANDLER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_ESH_CO_REFERENCE_REQUESTS			20090622
2	MV_EXEC_MODE	Instance attribute	Private	☐	Type reference (TYPE)	ESH_E_CO_EXEC_MODE			20090622
3	MV_FUZZY_SIMILARITY	Instance attribute	Private	☐	Type reference (TYPE)	ESH_E_IF_FUZZY_SIMILARITY		Fuzzy Similarity 0..10000	20110603
4	MV_NUMBER_OF_RESULTS	Instance attribute	Private	☐	Type reference (TYPE)	INT4			20090622
5	MV_SEARCH_DATE	Instance attribute	Private	☐	Type reference (TYPE)	DATUM			20090622
6	MV_SEARCH_LANGUAGE	Instance attribute	Private	☐	Type reference (TYPE)	LAISO			20090622
7	MV_SEARCH_REQUEST_ID	Instance attribute	Private	☐	Type reference (TYPE)	CHAR32			20090622
8	MV_SET_SEARCH_DATE	Instance attribute	Private	☐	Type reference (TYPE)	CHAR01			20090622
9	MV_SET_SEARCH_LANGUAGE	Instance attribute	Private	☐	Type reference (TYPE)	CHAR01			20090622
10	MV_SET_SEARCH_MODE	Instance attribute	Private	☐	Type reference (TYPE)	CHAR01			20090622
11	MV_SET_TIMEOUT	Instance attribute	Private	☐	Type reference (TYPE)	CHAR01		Set timeout	20090622
12	MV_START_INDEX	Instance attribute	Private	☐	Type reference (TYPE)	INT4			20090622
13	MV_TERM_ACTION	Instance attribute	Private	☐	Type reference (TYPE)	TREXD_TERM_ACTION			20090622
14	MV_TIMEOUT	Instance attribute	Private	☐	Type reference (TYPE)	ESH_E_IF_TIMEOUT		Search timeout (sec)	20090622

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	GET_INSTANCE	Static method	Public	Method	Get instance	20090617
2	GET_RESULTS_FOR_ATTRIBUTE	Instance method	Public	Method	Where-found: Get results for attribute	20090623
3	SET_MAX_NUMBER_OF_RESULTS	Instance method	Public	Method	Set page upper limit	20090622
4	SET_SEARCH_LANGUAGE	Instance method	Public	Method	Set search language (optional - default is all languages)	20090622
5	SET_SEARCH_MODE	Instance method	Public	Method	Set the search mode	20090622
6	SET_SEARCH_VALIDITY_BY_DATE	Instance method	Public	Method	Set search validity by date	20090622
7	SET_START_INDEX	Instance method	Public	Method	Set page lower limit	20090622
8	SET_TIMEOUT	Instance method	Public	Method	Set search timeout (sec)	20090622
9	WHERE_FOUND	Instance method	Public	Method	Determine in which request attributes search text is found	20090617

Events

Class CL_ESH_SE_FREESTYLE_ANALYSIS has no event.

Types

Class CL_ESH_SE_FREESTYLE_ANALYSIS has no local type.

Method Signatures

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RR_INSTANCE	Value transfer	☐	Object reference (TYPE REF TO)	CL_ESH_SE_FREESTYLE_ANALYSIS		Analysis Tools for Freestyle Search	20090617

Method GET_INSTANCE on class CL_ESH_SE_FREESTYLE_ANALYSIS has no exception.

Method GET_RESULTS_FOR_ATTRIBUTE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ER_RESULT_TAB	Call by reference	☐	Object reference (TYPE REF TO)	DATA			20090623
2	Importing	IV_REQUEST_ATTRIBUTE	Call by reference	☑	Type reference (TYPE)	ESH_E_OM_REQUEST_FIELD			20090623
3	Importing	IV_REQUEST_TYPE	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_CON_REQUEST_TYPE_ID			20090623
4	Importing	IV_SEARCH_CONNECTOR_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_SEARCH_CONNECTOR_ID			20090623
5	Importing	IV_SEARCH_STRING	Call by reference	☐	Type reference (TYPE)	STRING			20090623
6	Importing	IV_STAR_STRING_STAR_SEARCH	Call by reference	☐	Type reference (TYPE)	CHAR01	ABAP_TRUE		20090623

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_ENGINE	☐		20090623

Method SET_MAX_NUMBER_OF_RESULTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_NUMBER_OF_RESULTS	Call by reference	☐	Type reference (TYPE)	INT4	20	Requested number of results	20090622

Method SET_MAX_NUMBER_OF_RESULTS on class CL_ESH_SE_FREESTYLE_ANALYSIS has no exception.

Method SET_SEARCH_LANGUAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_LANGUAGE	Call by reference	☐	Type reference (TYPE)	LAISO		Search language (LAISO Format)	20090622

Method SET_SEARCH_LANGUAGE on class CL_ESH_SE_FREESTYLE_ANALYSIS has no exception.

Method SET_SEARCH_MODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_REF_REQ_HANDLER	Call by reference	☑	Object reference (TYPE REF TO)	CL_ESH_CO_REFERENCE_REQUESTS			20090622
2	Importing	IV_EXEC_MODE	Call by reference	☑	Type reference (TYPE)	ESH_E_CO_EXEC_MODE		Execution Mode	20090622
3	Importing	IV_FUZZY_SIMILARITY	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_FUZZY_SIMILARITY	7000	Fuzzy Similarity 0..10000	20110603
4	Importing	IV_TERM_ACTION	Call by reference	☑	Type reference (TYPE)	TREXD_TERM_ACTION		Term action (Exact, fuzzy)	20090622

Method SET_SEARCH_MODE on class CL_ESH_SE_FREESTYLE_ANALYSIS has no exception.

Method SET_SEARCH_VALIDITY_BY_DATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_DATE	Call by reference	☐	Type reference (TYPE)	DATUM		Date	20090622

Method SET_SEARCH_VALIDITY_BY_DATE on class CL_ESH_SE_FREESTYLE_ANALYSIS has no exception.

Method SET_START_INDEX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_START_INDEX	Call by reference	☐	Type reference (TYPE)	INT4	1	Start index	20090622

Method SET_START_INDEX on class CL_ESH_SE_FREESTYLE_ANALYSIS has no exception.

Method SET_TIMEOUT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_TIMEOUT	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_TIMEOUT		Search Timeout in seconds	20090622

Method SET_TIMEOUT on class CL_ESH_SE_FREESTYLE_ANALYSIS has no exception.

Method WHERE_FOUND Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_WHERE_FOUND	Call by reference	☐	Type reference (TYPE)	ESH_T_SE_WHERE_FOUND_RESULT		Where-Found Result Table	20090617
2	Importing	IV_REQUEST_TYPE	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_CON_REQUEST_TYPE_ID		Request Type ID	20090617
3	Importing	IV_SEARCH_CONNECTOR_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_IF_SEARCH_CONNECTOR_ID		Search Connector ID	20090617
4	Importing	IV_SEARCH_STRING	Call by reference	☐	Type reference (TYPE)	STRING		Search String	20090617
5	Importing	IV_STAR_STRING_STAR_SEARCH	Call by reference	☐	Type reference (TYPE)	CHAR01	ABAP_TRUE	Search for **	20090617

#	Exception	Resumable	Description	Created on
1	CX_ESH_IF_ENGINE	☐	ESH Interface Exception	20090617

History

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