SAP ABAP Class CL_ESH_IF_MDATA_KEYWORD (Meta Data: Keyword)
Hierarchy
☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-EIM-ESH (Application Component) NetWeaver Enterprise Search
     ⤷ S_ESH_ENG_INTERFACE (Package) Interface
Properties
Class CL_ESH_IF_MDATA_KEYWORD  
Short Description Meta Data: Keyword    
Super Class    
Instantiability of a Class 1  Protected 
Final    
General Data
Message Class    
Program status     
Category 0   
Package S_ESH_ENG_INTERFACE   Interface 
Created 20090602   SAP 
Last change 20110908   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_IF_MDATA_KEYWORD has no interface implemented.
Friends
# Friend Modeled only Created on Description
1 CL_ESH_IF_MDATA_CONNECTOR 20090603 Metadata: Search Connector
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 MS_KEYWORD_DATA Instance attribute Private Type reference (TYPE) IF_ESH_SE_RUNTIME_DATA=>S_KEYWORD_SORTED Keyword with table of Connector IDs (sorted) 20090602
2 MV_ID Instance attribute Protected Type reference (TYPE) ESH_E_IF_KEYWORD Keyword 20090602
3 MV_IS_SEARCHABLE Instance attribute Protected Type reference (TYPE) ABAP_BOOL ABAP_UNDEFINED Is searchable 20090603
4 MV_LANGUAGE Instance attribute Protected Type reference (TYPE) SPRAS Language Key 20090602
5 SC_BUFFER_MAX_ENTRIES Constant Private Type reference (TYPE) INT4 500 Maximum amount of entries in connector buffer 20090603
6 ST_KEYWORDS Static Attribute Private Type reference (TYPE) LTT_KEYWORD Keyword instances 20090603
7 ST_KEYWORDS_FROM_BUFFER Static Attribute Private Type reference (TYPE) IF_ESH_SE_RUNTIME_DATA=>T_KEYWORDS_SORTED Keywords with tables of Connector IDs (sorted) 20090602
Methods
# Method Level Visibility Method type Description Created on
1 CONSTRUCTOR Instance method Protected Constructor Constructor 20090602
2 GET_CONNECTORS Instance method Public Method Get connectors 20090603
3 GET_ID Instance method Public Method Get ID 20090603
4 GET_KEYWORD Static method Public Method Get keyword instance 20090602
5 GET_KEYWORD_IDS Static method Public Method Get keyword IDs 20090602
6 IS_SEARCHABLE Instance method Public Method At least one connector is searchable 20090603
7 REFRESH_STATUS Static method Protected Method Refresh status on all instances 20090603
Events
Class CL_ESH_IF_MDATA_KEYWORD has no event.
Types
# Type Visibility Typing Associated Type Description Created on Type Source
1 LST_KEYWORD Private See coding Keyword instance 20090603 BEGIN OF lst_keyword, id TYPE esh_e_if_keyword, instance TYPE REF TO cl_esh_if_mdata_keyword, END OF lst_keyword
2 LTT_KEYWORD Private See coding Keyword instances 20090603 ltt_keyword TYPE SORTED TABLE OF lst_keyword WITH UNIQUE KEY id
Method Signatures

Method CONSTRUCTOR Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_ID Call by reference Type reference (TYPE) ESH_E_IF_KEYWORD 20090602
2 Importing IV_LANGUAGE Call by reference Type reference (TYPE) SYLANGU SY-LANGU Language Key of Current Text Environment 20090602
# Exception Resumable Description Created on
1 CX_ESH_IF_ENGINE ESH Interface Exception 20090602

Method GET_CONNECTORS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_CONNECTORS Call by reference Type reference (TYPE) ESH_T_IF_MDATA_CONNECTOR_OBJ Meta Data: Connector Objects 20090603
2 Importing IV_ONLY_SEARCHABLE Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE Only searchable connectors 20090603

Method GET_CONNECTORS on class CL_ESH_IF_MDATA_KEYWORD has no exception.

Method GET_ID Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_ID Value transfer Type reference (TYPE) ESH_E_IF_KEYWORD Keyword 20090603

Method GET_ID on class CL_ESH_IF_MDATA_KEYWORD has no exception.

Method GET_KEYWORD Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_KEYWORD_ID Call by reference Type reference (TYPE) ESH_E_IF_KEYWORD Keyword 20090602
2 Returning RO_KEYWORD Value transfer Object reference (TYPE REF TO) CL_ESH_IF_MDATA_KEYWORD Meta Data: Keyword 20090602
# Exception Resumable Description Created on
1 CX_ESH_IF_ENGINE ESH Interface Exception 20090602

Method GET_KEYWORD_IDS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_KEYWORDS Call by reference Type reference (TYPE) ESH_T_IF_MDATA_KEYWORDS Meta Data: Keywords 20090602
2 Importing IV_ONLY_SEARCHABLE Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE Only with searchable connectors 20090605
# Exception Resumable Description Created on
1 CX_ESH_IF_ENGINE ESH Interface Exception 20090602

Method IS_SEARCHABLE Signature

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

Method IS_SEARCHABLE on class CL_ESH_IF_MDATA_KEYWORD has no exception.

Method REFRESH_STATUS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_SEARCHABILITY Call by reference Type reference (TYPE) ABAP_BOOL ABAP_TRUE Refresh searchability status 20090603

Method REFRESH_STATUS on class CL_ESH_IF_MDATA_KEYWORD has no exception.
History
Last changed by/on SAP  20110908 
SAP Release Created in 730