SAP ABAP Class CL_ESH_IF_MDATA_TEMPLATE (Metadata: Template)
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_TEMPLATE  
Short Description Metadata: Template    
Super Class    
Instantiability of a Class 1  Protected 
Final    
General Data
Message Class    
Program status     
Category 0   
Package S_ESH_ENG_INTERFACE   Interface 
Created 20080212   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)
2 IF_ESH_SE_RUNTIME_DATA Forward declaration interface (INTERFACE i DEFINITION DEF...  Forward declaration interface (INTERFACE i DEFINITION DEF...
Interfaces
Class CL_ESH_IF_MDATA_TEMPLATE has no interface implemented.
Friends
# Friend Modeled only Created on Description
1 CL_ESH_IF_MDATA_CONNECTOR 20090123 Metadata: Search Connector
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 MS_TEMPLATE_DATA Instance attribute Private Type reference (TYPE) IF_ESH_SE_RUNTIME_DATA=>S_TEMPLATE_SORTED Template (sorted) 20090113
2 MV_DESCRIPTION Instance attribute Protected Type reference (TYPE) ESH_E_IF_NAME Readable name 20080212
3 MV_ID Instance attribute Protected Type reference (TYPE) ESH_E_IF_TEMPLATE_ID Search connector template ID 20080212
4 MV_IS_SEARCHABLE Instance attribute Protected Type reference (TYPE) ABAP_BOOL ABAP_UNDEFINED Is searchable 20090113
5 SC_BUFFER_MAX_ENTRIES Constant Private Type reference (TYPE) INT4 500 Maximum number of entries in connector buffer 20080526
6 ST_TEMPLATES Static Attribute Private Type reference (TYPE) LTT_TEMPLATE Template instances 20080526
Methods
# Method Level Visibility Method type Description Created on
1 COMPOSE_TEMPLATE_ID Static method Public Method Compose template ID by components 20101007
2 CONSTRUCTOR Instance method Protected Constructor Constructor 20080212
3 GET_CONNECTORS Instance method Public Method Get connectors 20080212
4 GET_DESCRIPTION Instance method Public Method Get description 20080212
5 GET_ID Instance method Public Method Get ID 20080212
6 GET_LANGUAGES Static method Private Method Get relevant languages 20080313
7 GET_TEMPLATE Static method Public Method Get template instance 20080212
8 GET_TEMPLATE_IDS Static method Public Method Get template IDs 20080212
9 IS_SEARCHABLE Instance method Public Method At least one connector is searchable 20090113
10 REFRESH_STATUS Static method Protected Method Refresh status on all instances 20090122
Events
Class CL_ESH_IF_MDATA_TEMPLATE has no event.
Types
# Type Visibility Typing Associated Type Description Created on Type Source
1 LST_TEMPLATE Private See coding 20080526 begin of lst_template, id type esh_e_if_template_id, instance type ref to cl_esh_if_mdata_template, END OF lst_template
2 LTT_TEMPLATE Private See coding 20080526 ltt_template type SORTED TABLE OF lst_template with UNIQUE KEY id
Method Signatures

Method COMPOSE_TEMPLATE_ID Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_OBJECT_TYPE_ID Call by reference Type reference (TYPE) ESH_E_OM_OBJECT_TYPE Object Type 20101007
2 Importing IV_SOFTWARE_COMPONENT Call by reference Type reference (TYPE) ESH_E_OM_SYSREL Software Component 20101007
3 Returning RV_TEMPLATE_ID Value transfer Type reference (TYPE) ESH_E_IF_TEMPLATE_ID Search Connector Template ID 20101007
# Exception Resumable Description Created on
1 CX_ESH_IF_ENGINE ESH Interface Exception 20101007

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_TEMPLATE_ID Search Connector Template ID 20080212
# Exception Resumable Description Created on
1 CX_ESH_IF_ENGINE ESH Interface Exception 20080229

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 20080212
2 Importing IV_ONLY_SEARCHABLE Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE Only searchable connectors 20090122

Method GET_CONNECTORS on class CL_ESH_IF_MDATA_TEMPLATE has no exception.

Method GET_DESCRIPTION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_DESCRIPTION Value transfer Type reference (TYPE) ESH_E_IF_NAME Readable Name 20080212

Method GET_DESCRIPTION on class CL_ESH_IF_MDATA_TEMPLATE 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_TEMPLATE_ID Search Connector Template ID 20080212

Method GET_ID on class CL_ESH_IF_MDATA_TEMPLATE has no exception.

Method GET_LANGUAGES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_LANGUAGES Call by reference Type reference (TYPE) ESH_T_OM_LANGU Table of Languages used for Admin 20080313

Method GET_LANGUAGES on class CL_ESH_IF_MDATA_TEMPLATE has no exception.

Method GET_TEMPLATE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_TEMPLATE_ID Call by reference Type reference (TYPE) ESH_E_IF_TEMPLATE_ID Search Connector Template ID 20080212
2 Returning RO_TEMPLATE Value transfer Object reference (TYPE REF TO) CL_ESH_IF_MDATA_TEMPLATE Meta Data: Template 20080212
# Exception Resumable Description Created on
1 CX_ESH_IF_ENGINE ESH Interface Exception 20080305

Method GET_TEMPLATE_IDS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_TEMPLATES Call by reference Type reference (TYPE) ESH_T_IF_MDATA_TEMPLATES Meta Data: Templates 20080212
2 Importing IV_ONLY_SEARCHABLE Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE Only searchable templates 20090122

Method GET_TEMPLATE_IDS on class CL_ESH_IF_MDATA_TEMPLATE has no exception.

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 20090113

Method IS_SEARCHABLE on class CL_ESH_IF_MDATA_TEMPLATE 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 20090122

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