SAP ABAP Class CL_ESH_IF_MDATA_UI_AREA (Meta Data: UI Area)

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_UI_AREA
Short Description	Meta Data: UI Area
Super Class
Instantiability of a Class	1	Protected
Final	☑

General Data

Message Class
Program status
Category	0
Package	S_ESH_ENG_INTERFACE	Interface
Created	20090114	SAP
Last change	20140121	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	CL_ESH_IF_MDATA_ATTRIBUTE_TYPE	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
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_UI_AREA has no interface implemented.

Friends

#	Friend	Modeled only	Created on	Description
1	CL_ESH_IF_MDATA_ATTRIBUTE_TYPE	☐	20090114	Metadata: Attribute Type
2	CL_ESH_IF_MDATA_ATTR_GROUP	☐	20091106	Metadata: Attribute Group
3	CL_ESH_IF_MDATA_CONNECTOR	☐	20100304	Metadata: Search Connector

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MT_NAMES	Instance attribute	Private	☐	Type reference (TYPE)	IF_ESH_SE_RUNTIME_DATA=>T_LANGU_NAMES_SORTED		Language dependent names (sorted)	20090114
2	MV_DESCRIPTION	Instance attribute	Protected	☐	Type reference (TYPE)	ESH_E_IF_NAME		Readable Name	20090114
3	MV_ID	Instance attribute	Protected	☐	Type reference (TYPE)	ESH_E_OM_UI_AREA		UI Area	20090114
4	SC_BUFFER_MAX_ENTRIES	Constant	Private	☐	Type reference (TYPE)	INT4	50	Maximum amount of entries in ui area buffer	20090114
5	SC_UI_AREA_DETAILS	Constant	Public	☐	Type reference (TYPE)	ESH_E_IF_UI_AREA	CL_ESH_IF_MDATA_ATTRIBUTE_TYPE=>SC_UI_AREA_DETAILS	UI Area "Details"	20090203
6	SC_UI_AREA_FACTSHEET	Constant	Public	☐	Type reference (TYPE)	ESH_E_IF_UI_AREA	CL_ESH_IF_MDATA_ATTRIBUTE_TYPE=>SC_UI_AREA_FACTSHEET	UI Area "Factsheet"	20130404
7	SC_UI_AREA_IMAGE	Constant	Public	☐	Type reference (TYPE)	ESH_E_IF_UI_AREA	CL_ESH_IF_MDATA_ATTRIBUTE_TYPE=>SC_UI_AREA_IMAGE	UI Area "Image"	20090203
8	SC_UI_AREA_LONGTEXT	Constant	Public	☐	Type reference (TYPE)	ESH_E_IF_UI_AREA	CL_ESH_IF_MDATA_ATTRIBUTE_TYPE=>SC_UI_AREA_LONGTEXT	UI area "Longtext"	20110831
9	SC_UI_AREA_SUMMARY	Constant	Public	☐	Type reference (TYPE)	ESH_E_IF_UI_AREA	CL_ESH_IF_MDATA_ATTRIBUTE_TYPE=>SC_UI_AREA_SUMMARY	UI Area "Summary"	20090203
10	SC_UI_AREA_THUMBNAIL	Constant	Public	☐	Type reference (TYPE)	ESH_E_IF_UI_AREA	CL_ESH_IF_MDATA_ATTRIBUTE_TYPE=>SC_UI_AREA_THUMBNAIL	UI Area "Thumbnail"	20090203
11	SC_UI_AREA_TITLE	Constant	Public	☐	Type reference (TYPE)	ESH_E_IF_UI_AREA	CL_ESH_IF_MDATA_ATTRIBUTE_TYPE=>SC_UI_AREA_TITLE	UI Area "Title"	20090203
12	ST_UI_AREAS	Static Attribute	Private	☐	Type reference (TYPE)	LTT_UI_AREAS			20090114

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONSTRUCTOR	Instance method	Protected	Constructor	Constructor	20090114
2	GET_DESCRIPTION	Instance method	Public	Method	Get Description	20090114
3	GET_ID	Instance method	Public	Method	Get ID	20090114
4	GET_INSTANCE	Static method	Protected	Method	Get Instance	20090114
5	GET_LANGUAGES	Static method	Private	Method	Get relevant languages	20090114

Events

Class CL_ESH_IF_MDATA_UI_AREA has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	LST_UI_AREA	Private	See coding			20090114	BEGIN OF lst_ui_area, id TYPE esh_e_om_ui_area, instance TYPE REF TO cl_esh_if_mdata_ui_area, END OF lst_ui_area
2	LTT_UI_AREAS	Private	See coding			20090114	ltt_ui_areas TYPE SORTED TABLE OF lst_ui_area 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	IR_CONNECTOR_DATA	Call by reference	☐	Object reference (TYPE REF TO)	IF_ESH_SE_RUNTIME_DATA=>S_CONNECTOR_SORTED			20090114
2	Importing	IV_UI_AREA_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_UI_AREA		UI Area	20090114

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

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	20090114

Method GET_DESCRIPTION on class CL_ESH_IF_MDATA_UI_AREA 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_OM_UI_AREA		UI Area	20090114

Method GET_ID on class CL_ESH_IF_MDATA_UI_AREA has no exception.

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_CONNECTOR_DATA	Call by reference	☐	Object reference (TYPE REF TO)	IF_ESH_SE_RUNTIME_DATA=>S_CONNECTOR_SORTED			20090114
2	Importing	IV_UI_AREA_ID	Call by reference	☐	Type reference (TYPE)	ESH_E_OM_UI_AREA		UI Area	20090114
3	Returning	RO_UI_AREA	Value transfer	☐	Object reference (TYPE REF TO)	CL_ESH_IF_MDATA_UI_AREA		Meta Data: UI Area	20090114

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

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	20090114

Method GET_LANGUAGES on class CL_ESH_IF_MDATA_UI_AREA has no exception.

History

Last changed by/on	SAP	20140121
SAP Release Created in	720