SAP ABAP Class CL_ESH_FED_SUGGESTIONS_MANAGER (Suggestion Manager)
Hierarchy
☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-EIM-ESH (Application Component) NetWeaver Enterprise Search
     ⤷ S_ESH_ENG_FEDERATION (Package) Federation
Properties
Class CL_ESH_FED_SUGGESTIONS_MANAGER  
Short Description Suggestion Manager    
Super Class    
Instantiability of a Class 2  Public 
Final    
General Data
Message Class    
Program status     
Category 0   
Package S_ESH_ENG_FEDERATION   Federation 
Created 20090320   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_FED_SUGGESTIONS_MANAGER has no interface implemented.
Friends
Class CL_ESH_FED_SUGGESTIONS_MANAGER has no friend class.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 INSTANCE Static Attribute Private Object reference (TYPE REF TO) CL_ESH_FED_SUGGESTIONS_MANAGER Instance 20100811
2 MT_PROVIDERS Instance attribute Private Type reference (TYPE) T_PROVIDER Providers 20100811
3 MV_PROVIDERS_DETERMINED Instance attribute Private Type reference (TYPE) CHAR01 Providers determined 20100817
Methods
# Method Level Visibility Method type Description Created on
1 ADJUST_SEARCHTERM Instance method Private Method Adjust term, e.g. "new york" -> "new york" 20110617
2 CHK_TERMS_SUPPORT_SUGGESTIONS Instance method Private Method Check whether terms support suggestions 20110420
3 COLLECT_PROVIDERS Instance method Private Method Collection of all active suggestion providers 20090323
4 CONVERT_FROM_JSON Static method Public Method Convert suggestions from JSON to structured data 20090323
5 CONVERT_TO_JSON Static method Public Method Convert suggestions from structured data to JSON 20090323
6 GET_INSTANCE Static method Public Method Get instance 20100811
7 GET_SUGGESTIONS Instance method Public Method Get suggestions 20090320
8 IS_AVAILABLE Instance method Public Method Suggestion service is available 20090323
Events
Class CL_ESH_FED_SUGGESTIONS_MANAGER has no event.
Types
# Type Visibility Typing Associated Type Description Created on Type Source
1 S_PROVIDER Private See coding 20090320 BEGIN OF s_provider, provider TYPE REF TO if_esh_fed_provide_suggestions, END OF s_provider
2 T_PROVIDER Private See coding 20090320 t_provider TYPE TABLE OF s_provider
Method Signatures

Method ADJUST_SEARCHTERM Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EV_ADJUSTED_TERM Call by reference Type reference (TYPE) ESH_E_IF_SEARCH_STRING Adjusted Search String 20110617
2 Importing IV_TERM Call by reference Type reference (TYPE) ESH_E_IF_SEARCH_STRING Search String 20110617

Method ADJUST_SEARCHTERM on class CL_ESH_FED_SUGGESTIONS_MANAGER has no exception.

Method CHK_TERMS_SUPPORT_SUGGESTIONS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_SEARCH_TERMS Call by reference Type reference (TYPE) ESH_E_IF_SEARCH_STRING Search String 20110420
2 Returning RV_SUPPORTED Value transfer Type reference (TYPE) CHAR01 Is Supported 20110420

Method CHK_TERMS_SUPPORT_SUGGESTIONS on class CL_ESH_FED_SUGGESTIONS_MANAGER has no exception.

Method COLLECT_PROVIDERS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_PROVIDERS Call by reference Type reference (TYPE) T_PROVIDER 20090323

Method COLLECT_PROVIDERS on class CL_ESH_FED_SUGGESTIONS_MANAGER has no exception.

Method CONVERT_FROM_JSON Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_SUGGESTIONS Call by reference Type reference (TYPE) ESH_T_IF_SUGGESTIONS Suggestions for a search input 20090323
2 Importing IV_JSON Call by reference Type reference (TYPE) STRING 20090323

Method CONVERT_FROM_JSON on class CL_ESH_FED_SUGGESTIONS_MANAGER has no exception.

Method CONVERT_TO_JSON Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_SUGGESTIONS Call by reference Type reference (TYPE) ESH_T_IF_SUGGESTIONS Suggestions for a search input 20090323
2 Importing IV_SEARCH_TERMS Call by reference Type reference (TYPE) ESH_E_IF_SEARCH_STRING Original search terms 20090323
3 Returning RV_JSON Value transfer Type reference (TYPE) STRING 20090323

Method CONVERT_TO_JSON on class CL_ESH_FED_SUGGESTIONS_MANAGER has no exception.

Method GET_INSTANCE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RO_SUGGESTER Value transfer Object reference (TYPE REF TO) CL_ESH_FED_SUGGESTIONS_MANAGER Suggestions Manager 20100811

Method GET_INSTANCE on class CL_ESH_FED_SUGGESTIONS_MANAGER has no exception.

Method GET_SUGGESTIONS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_SUGGESTIONS Call by reference Type reference (TYPE) ESH_T_IF_SUGGESTIONS Suggestions for a search input 20090320
2 Importing IT_SCOPE Call by reference Type reference (TYPE) ESH_T_IF_SCOPE Scope of Search Request 20090320
3 Importing IV_NUMBER_OF_SUGGESTIONS Call by reference Type reference (TYPE) ESH_E_IF_NO_OF_RESULTS 10 Number of Results 20100401
4 Importing IV_SEARCH_TERMS Call by reference Type reference (TYPE) ESH_E_IF_SEARCH_STRING Search String 20090320

Method GET_SUGGESTIONS on class CL_ESH_FED_SUGGESTIONS_MANAGER has no exception.

Method IS_AVAILABLE Signature

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

Method IS_AVAILABLE on class CL_ESH_FED_SUGGESTIONS_MANAGER has no exception.
History
Last changed by/on SAP  20130531 
SAP Release Created in 720