SAP ABAP Class CL_ESH_IF_MDATA_ATTR_ENTITY (Metadata: Attribute Entity)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-EIM-ESH (Application Component) NetWeaver Enterprise Search
⤷
S_ESH_ENG_INTERFACE (Package) Interface
SAP_BASIS (Software Component) SAP Basis Component⤷
BC-EIM-ESH (Application Component) NetWeaver Enterprise Search⤷
S_ESH_ENG_INTERFACE (Package) InterfaceMeta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Inheritance (c INHERITING FROM c_ref) | CL_ESH_IF_MDATA_ATTRIBUTE_TYPE | Metadata: Attribute Type | 20091109 |
| 2 | Inheritance (c INHERITING FROM c_ref) | CL_ESH_IF_MDATA_ATTR_GROUP | Metadata: Attribute Group | 20091106 |
Properties
| Class | CL_ESH_IF_MDATA_ATTR_ENTITY | |
| Short Description | Metadata: Attribute Entity | |
| Super Class | ||
| Instantiability of a Class | 1 | Protected |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | S_ESH_ENG_INTERFACE | Interface |
| Created | 20091106 | SAP |
| Last change | 20140121 | 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 | CL_ESH_OM_CONSTANTS |
Forward declaration class (CLASS c DEFINITION DEFERRED) | Forward declaration class (CLASS c DEFINITION DEFERRED) |
Interfaces
Class CL_ESH_IF_MDATA_ATTR_ENTITY has no interface implemented.
Friends
| # | Friend | Modeled only | Created on | Description |
|---|---|---|---|---|
| 1 | CL_ESH_IF_MDATA_CONNECTOR | 20091106 | Metadata: Search Connector | |
| 2 | CL_ESH_IF_MDATA_REQUEST_TYPE | 20091106 | Metadata: Request Type |
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | MV_ID |
Instance attribute | Protected | Type reference (TYPE) | ESH_E_IF_ATTRIBUTE_ENTITY_ID | Attribute entity ID | 20091106 | ||
| 2 | SC_ENTITY_TYPE_ATTRIBUTE |
Constant | Public | Type reference (TYPE) | ESH_E_IF_ATTRIBUTE_ENTITY_TYPE | 'A' | Attribute entity type: Attribute | 20091106 | |
| 3 | SC_ENTITY_TYPE_GROUP |
Constant | Public | Type reference (TYPE) | ESH_E_IF_ATTRIBUTE_ENTITY_TYPE | 'G' | Attribute entity type: Group | 20091106 | |
| 4 | SC_UI_AREA_DETAILS |
Constant | Public | Type reference (TYPE) | ESH_E_IF_UI_AREA | 'DETAILS' | UI area "Details" | 20091106 | |
| 5 | SC_UI_AREA_FACTSHEET |
Constant | Public | Type reference (TYPE) | ESH_E_IF_UI_AREA | 'FACTSHEET' | UI area "Factsheet" | 20130404 | |
| 6 | SC_UI_AREA_IMAGE |
Constant | Public | Type reference (TYPE) | ESH_E_IF_UI_AREA | 'DETAILIMAGE' | UI area "Image" | 20091106 | |
| 7 | SC_UI_AREA_LONGTEXT |
Constant | Public | Type reference (TYPE) | ESH_E_IF_UI_AREA | 'LONGTEXT' | UI area "Longtext" | 20110831 | |
| 8 | SC_UI_AREA_SUMMARY |
Constant | Public | Type reference (TYPE) | ESH_E_IF_UI_AREA | 'SUMMARY' | UI area "Summary" | 20091106 | |
| 9 | SC_UI_AREA_THUMBNAIL |
Constant | Public | Type reference (TYPE) | ESH_E_IF_UI_AREA | 'PREVIEWIMAGE' | UI area "Thumbnail" | 20091106 | |
| 10 | SC_UI_AREA_TITLE |
Constant | Public | Type reference (TYPE) | ESH_E_IF_UI_AREA | 'TITLE' | UI area "Title" | 20091106 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | GET_DESCRIPTION |
Instance method | Public | Method | Get description | 20091106 |
| 2 | GET_ENTITY_TYPE |
Instance method | Public | Method | Get entity type | 20091106 |
| 3 | GET_ID |
Instance method | Public | Method | Get ID | 20091106 |
| 4 | GET_LANGUAGES |
Static method | Protected | Method | Get relevant languages | 20091106 |
| 5 | GET_UI_AREAS |
Instance method | Public | Method | UI areas the attribute is assigned to | 20091106 |
| 6 | IS_GROUPED |
Instance method | Public | Method | Attribute entity is part of an attribute group | 20130708 |
| 7 | IS_LABELED |
Instance method | Public | Method | Show attribute entity with label | 20100830 |
Events
Class CL_ESH_IF_MDATA_ATTR_ENTITY has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | S_ATTRIBUTE_ENTITY | Protected | See coding | Attribute Entity | 20100211 | BEGIN OF s_attribute_entity,
id TYPE char32,
object TYPE REF TO cl_esh_if_mdata_attr_entity,
END OF s_attribute_entity
|
|
| 2 | T_ATTRIBUTE_ENTITIES | Protected | See coding | 20100211 | t_attribute_entities TYPE SORTED TABLE OF s_attribute_entity WITH UNIQUE KEY id
|
Method Signatures
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 | 20091106 |
Method GET_DESCRIPTION on class CL_ESH_IF_MDATA_ATTR_ENTITY has no exception.
Method GET_ENTITY_TYPE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RV_ENTITY_TYPE | Value transfer | Type reference (TYPE) | ESH_E_IF_ATTRIBUTE_ENTITY_TYPE | Attribute Entity Type | 20091106 |
Method GET_ENTITY_TYPE on class CL_ESH_IF_MDATA_ATTR_ENTITY 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_ATTRIBUTE_ENTITY_ID | Attribute Entity ID | 20091106 |
Method GET_ID on class CL_ESH_IF_MDATA_ATTR_ENTITY 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 | 20091106 |
Method GET_LANGUAGES on class CL_ESH_IF_MDATA_ATTR_ENTITY has no exception.
Method GET_UI_AREAS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_UI_AREAS | Call by reference | Type reference (TYPE) | ESH_T_IF_UI_AREAS | UI Areas | 20091106 | ||
| 2 | Exporting |
ET_UI_AREA_OBJECTS | Call by reference | Type reference (TYPE) | ESH_T_IF_MDATA_UI_AREA_OBJ | Meta Data: UI Area Objects | 20091106 |
Method GET_UI_AREAS on class CL_ESH_IF_MDATA_ATTR_ENTITY has no exception.
Method IS_GROUPED 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 | 20130708 |
Method IS_GROUPED on class CL_ESH_IF_MDATA_ATTR_ENTITY has no exception.
Method IS_LABELED 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 | Is labeled | 20100830 |
Method IS_LABELED on class CL_ESH_IF_MDATA_ATTR_ENTITY has no exception.
History
| Last changed by/on | SAP | 20140121 |
| SAP Release Created in | 730 |
