SAP ABAP Class CL_ESH_IF_MDATA_COMMON_ATTR (Meta Data: Common Attribute)
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_COMMON_ATTR | |
| Short Description | Meta Data: Common Attribute | |
| Super Class | ||
| Instantiability of a Class | 1 | Protected |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | S_ESH_ENG_INTERFACE | Interface |
| Created | 20091210 | SAP |
| Last change | 20130531 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) | |
| 2 | Forward declaration class (CLASS c DEFINITION DEFERRED) | Forward declaration class (CLASS c DEFINITION DEFERRED) |
Interfaces
Class CL_ESH_IF_MDATA_COMMON_ATTR has no interface implemented.
Friends
| # | Friend | Modeled only | Created on | Description |
|---|---|---|---|---|
| 1 | CL_ESH_IF_MDATA_REQUEST_TYPE | 20091214 | Metadata: Request Type |
Attributes
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Protected | Constructor | Constructor | 20091210 | |
| 2 | Instance method | Public | Method | Get request type attributes | 20091210 | |
| 3 | Instance method | Public | Method | Get description | 20091210 | |
| 4 | Instance method | Public | Method | Get ID | 20091210 | |
| 5 | Static method | Protected | Method | Get instance | 20091210 | |
| 6 | Static method | Public | Method | Get joint common attributes of multiple request types | 20091214 | |
| 7 | Static method | Protected | Method | Get relevant languages | 20091210 | |
| 8 | Instance method | Public | Method | Is used in advanced search | 20091210 | |
| 9 | Instance method | Public | Method | Is a filter attribute | 20091210 | |
| 10 | Instance method | Public | Method | Attribute can be used to sort search results | 20091210 |
Events
Class CL_ESH_IF_MDATA_COMMON_ATTR has no event.
Types
Class CL_ESH_IF_MDATA_COMMON_ATTR has no local type.
Method Signatures
Method CONSTRUCTOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IO_CONNECTOR | Call by reference | Object reference (TYPE REF TO) | CL_ESH_IF_MDATA_CONNECTOR | Meta Data: Search Connector | 20091210 | |||
| 2 | IR_ATTRIBUTE_TYPES_DATA | Call by reference | Object reference (TYPE REF TO) | IF_ESH_SE_RUNTIME_DATA=>T_ATTRIBUTE_TYPES_SORTED | 20091210 | ||||
| 3 | IR_COMMON_ATTRIBUTE_DATA | Call by reference | Object reference (TYPE REF TO) | IF_ESH_SE_RUNTIME_DATA=>S_COMMON_ATTRIBUTE_SORTED | 20091210 | ||||
| 4 | IR_CONNECTOR_DATA | Call by reference | Object reference (TYPE REF TO) | IF_ESH_SE_RUNTIME_DATA=>S_CONNECTOR_SORTED | 20091210 |
Method CONSTRUCTOR on class CL_ESH_IF_MDATA_COMMON_ATTR has no exception.
Method GET_ATTRIBUTE_TYPES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_ATTRIBUTE_TYPES | Call by reference | Type reference (TYPE) | ESH_T_IF_MDATA_ATTRIBUTE_TYOBJ | Meta Data: Attribute Type Objects | 20091210 |
Method GET_ATTRIBUTE_TYPES on class CL_ESH_IF_MDATA_COMMON_ATTR has no exception.
Method GET_DESCRIPTION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RV_DESCRIPTION | Value transfer | Type reference (TYPE) | ESH_E_IF_NAME | Readable Name | 20091210 |
Method GET_DESCRIPTION on class CL_ESH_IF_MDATA_COMMON_ATTR has no exception.
Method GET_ID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RV_ID | Value transfer | Type reference (TYPE) | ESH_E_IF_COMMON_ATTRIBUTE_ID | Common Attribute ID | 20091210 |
Method GET_ID on class CL_ESH_IF_MDATA_COMMON_ATTR has no exception.
Method GET_INSTANCE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IO_CONNECTOR | Call by reference | Object reference (TYPE REF TO) | CL_ESH_IF_MDATA_CONNECTOR | Meta Data: Search Connector | 20091210 | |||
| 2 | IR_ATTRIBUTE_TYPES_DATA | Call by reference | Object reference (TYPE REF TO) | IF_ESH_SE_RUNTIME_DATA=>T_ATTRIBUTE_TYPES_SORTED | 20091210 | ||||
| 3 | IR_COMMON_ATTRIBUTE_DATA | Call by reference | Object reference (TYPE REF TO) | IF_ESH_SE_RUNTIME_DATA=>S_COMMON_ATTRIBUTE_SORTED | 20091210 | ||||
| 4 | IR_CONNECTOR_DATA | Call by reference | Object reference (TYPE REF TO) | IF_ESH_SE_RUNTIME_DATA=>S_CONNECTOR_SORTED | 20091210 | ||||
| 5 | RO_COMMON_ATTRIBUTE | Value transfer | Object reference (TYPE REF TO) | CL_ESH_IF_MDATA_COMMON_ATTR | Meta Data: Common Attribute | 20091210 |
Method GET_INSTANCE on class CL_ESH_IF_MDATA_COMMON_ATTR has no exception.
Method GET_JOINT_COMMON_ATTRIBUTE_IDS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_COMMON_ATTRIBUTE_IDS | Call by reference | Type reference (TYPE) | ESH_T_IF_MDATA_COMMON_ATTR_IDS | Meta Data: Common Attribute IDs | 20091214 | |||
| 2 | IT_REQUEST_TYPES | Call by reference | Type reference (TYPE) | ESH_T_IF_MDATA_REQUEST_TY_OBJ2 | Meta Data: Request Type Objects | 20091214 | |||
| 3 | IV_ONLY_FILTER_CRITERION | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Only Common Attributes usable as filter criterion | 20110916 | ||
| 4 | IV_ONLY_SORTABLE | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Only sortable Common Attributes | 20100218 |
Method GET_JOINT_COMMON_ATTRIBUTE_IDS on class CL_ESH_IF_MDATA_COMMON_ATTR has no exception.
Method GET_LANGUAGES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_LANGUAGES | Call by reference | Type reference (TYPE) | ESH_T_OM_LANGU | Table of Languages used for Admin | 20091210 |
Method GET_LANGUAGES on class CL_ESH_IF_MDATA_COMMON_ATTR has no exception.
Method IS_ADVANCED_SEARCH Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RV_TRUE | Value transfer | Type reference (TYPE) | ABAP_BOOL | 20091210 |
Method IS_ADVANCED_SEARCH on class CL_ESH_IF_MDATA_COMMON_ATTR has no exception.
Method IS_FILTER_CRITERION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RV_TRUE | Value transfer | Type reference (TYPE) | ABAP_BOOL | 20091210 |
Method IS_FILTER_CRITERION on class CL_ESH_IF_MDATA_COMMON_ATTR has no exception.
Method IS_SORTABLE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RV_TRUE | Value transfer | Type reference (TYPE) | ABAP_BOOL | 20091210 |
Method IS_SORTABLE on class CL_ESH_IF_MDATA_COMMON_ATTR has no exception.
History
| Last changed by/on | SAP | 20130531 |
| SAP Release Created in | 730 |