SAP ABAP Class CL_ESH_SEARCH_UI_CA_HELPER (Common Attributes (Helper Class))
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-EIM-ESH (Application Component) NetWeaver Enterprise Search
⤷
S_ESH_UI_SEARCH_UI (Package) Search UI
SAP_BASIS (Software Component) SAP Basis Component⤷
BC-EIM-ESH (Application Component) NetWeaver Enterprise Search⤷
S_ESH_UI_SEARCH_UI (Package) Search UIProperties
| Class | CL_ESH_SEARCH_UI_CA_HELPER | |
| Short Description | Common Attributes (Helper Class) | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | S_ESH_UI_SEARCH_UI | Search UI |
| Created | 20100113 | SAP |
| Last change | 20130531 | 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_SEARCH_UI_CA_HELPER |
Forward declaration class (CLASS c DEFINITION DEFERRED) | Forward declaration class (CLASS c DEFINITION DEFERRED) |
Interfaces
Class CL_ESH_SEARCH_UI_CA_HELPER has no interface implemented.
Friends
Class CL_ESH_SEARCH_UI_CA_HELPER has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | GT_CA |
Instance attribute | Private | Type reference (TYPE) | TY_T_CA | Common attribute types | 20100225 | ||
| 2 | GT_FILTER_ATTRIBUTES |
Instance attribute | Private | Type reference (TYPE) | ESH_T_FILTER_ATTRIBUTES | Filter attributes | 20100114 | ||
| 3 | GT_JCA_IDS |
Instance attribute | Private | Type reference (TYPE) | ESH_T_IF_MDATA_COMMON_ATTR_IDS | Joint common attribute IDs | 20100225 | ||
| 4 | GT_JRA_IDS |
Instance attribute | Private | Type reference (TYPE) | TY_T_CA_ID | Joint request attribute IDs | 20100225 | ||
| 5 | GT_REQUEST_TYPES |
Instance attribute | Private | Type reference (TYPE) | ESH_T_IF_MDATA_REQUEST_TY_OBJ2 | Metadata: Request type objects | 20100113 | ||
| 6 | GV_JOINT_CA |
Instance attribute | Private | Type reference (TYPE) | ABAP_BOOL | 'X' = Has joint common attributes | 20100802 | ||
| 7 | SO_CA_HELPER |
Static Attribute | Private | Object reference (TYPE REF TO) | CL_ESH_SEARCH_UI_CA_HELPER | Common attributes (helper class) | 20100113 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | GET_COMMON_ATTRIBUTES |
Instance method | Public | Method | Get common attributes | 20100118 |
| 2 | GET_COMMON_FILTER_ATTRIBUTES |
Instance method | Public | Method | Get common filter attributes | 20100113 |
| 3 | GET_INSTANCE |
Static method | Public | Method | Get instance | 20100113 |
| 4 | READ_CA_BY_CATEGORY_CONNECTOR |
Instance method | Private | Method | Read common attributes by category and/or connector | 20100225 |
Events
Class CL_ESH_SEARCH_UI_CA_HELPER has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | TY_S_CA | Public | See coding | Common attributes | 20100118 | BEGIN OF ty_s_ca.
INCLUDE TYPE CL_ESH_SEARCH_UI_COMMON=>TY_s_ATTR_PROP.
TYPES END OF ty_s_ca
|
|
| 2 | TY_S_CONNECTOR_ID | Public | See coding | Connector ID | 20100312 | BEGIN OF ty_s_connector_id,
connector_id TYPE esh_e_if_search_connector_id,
END OF ty_s_connector_id
|
|
| 3 | TY_T_CA | Public | See coding | Common attributes | 20100118 | ty_t_ca TYPE STANDARD TABLE OF ty_s_ca WITH DEFAULT KEY
|
|
| 4 | TY_T_CA_ID | Private | See coding | Common attribute ID | 20110909 | ty_t_ca_id TYPE STANDARD TABLE OF ESH_S_IF_MDATA_COMMON_ATTR_ID WITH DEFAULT KEY
|
|
| 5 | TY_T_CONNECTOR_ID | Public | See coding | Connector ID | 20100312 | ty_t_connector_id TYPE SORTED TABLE OF ty_s_connector_id WITH UNIQUE KEY connector_id
|
Method Signatures
Method GET_COMMON_ATTRIBUTES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
IT_CATEGORY_ID | Call by reference | Type reference (TYPE) | ESH_T_CATEGORY_ID | Category ID | 20100225 | ||
| 2 | Importing |
IT_CONNECTOR_ID | Call by reference | Type reference (TYPE) | ESH_T_CONNECTOR_ID | Connector ID | 20100225 | ||
| 3 | Importing |
IT_CONNECTOR_ID_SCOPE_DISTR | Call by reference | Type reference (TYPE) | TY_T_CONNECTOR_ID | Connector ID, from scope distribution | 20100325 | ||
| 4 | Importing |
IV_ONLY_SORTABLE | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Only sortable Common Attributes | 20100222 | |
| 5 |  Returning |
RT_CA | Value transfer | Type reference (TYPE) | TY_T_CA | Common attributes | 20100118 |
Method GET_COMMON_ATTRIBUTES on class CL_ESH_SEARCH_UI_CA_HELPER has no exception.
Method GET_COMMON_FILTER_ATTRIBUTES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
ET_FILTER_ATTRIBUTES | Call by reference | Type reference (TYPE) | ESH_T_FILTER_ATTRIBUTES | Filter Attributes | 20100802 | ||
| 2 | Exporting |
EV_JOINT_CA | Call by reference | Type reference (TYPE) | ABAP_BOOL | 'X' = Has joint Common Attributes | 20100802 | ||
| 3 | Importing |
IT_CATEGORY_ID | Call by reference | Type reference (TYPE) | ESH_T_CATEGORY_ID | Category ID | 20100225 | ||
| 4 | Importing |
IT_CONNECTOR_ID | Call by reference | Type reference (TYPE) | ESH_T_CONNECTOR_ID | Connector ID | 20100225 | ||
| 5 | Importing |
IT_CONNECTOR_ID_SCOPE_DISTR | Call by reference | Type reference (TYPE) | TY_T_CONNECTOR_ID | Connector ID, from scope distribution | 20100312 | ||
| 6 | Importing |
IV_ONLY_FILTER_CRITERION | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | 'X' = Only Common Attributes usable as filter criterion | 20110916 |
Method GET_COMMON_FILTER_ATTRIBUTES on class CL_ESH_SEARCH_UI_CA_HELPER has no exception.
Method GET_INSTANCE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RR_CA_HELPER | Value transfer | Object reference (TYPE REF TO) | CL_ESH_SEARCH_UI_CA_HELPER | Common attributes (helper class) | 20100113 |
Method GET_INSTANCE on class CL_ESH_SEARCH_UI_CA_HELPER has no exception.
Method READ_CA_BY_CATEGORY_CONNECTOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IT_CATEGORY_ID | Call by reference | Type reference (TYPE) | ESH_T_CATEGORY_ID | Category ID | 20100225 | ||
| 2 | Importing |
IT_CONNECTOR_ID | Call by reference | Type reference (TYPE) | ESH_T_CONNECTOR_ID | Connector ID | 20100225 | ||
| 3 | Importing |
IT_CONNECTOR_ID_SCOPE_DISTR | Call by reference | Type reference (TYPE) | TY_T_CONNECTOR_ID | Connector ID, from scope distribution | 20100312 | ||
| 4 | Importing |
IV_ONLY_FILTER_CRITERION | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Only Common Attributes usable as filter criterion | 20110916 | |
| 5 | Importing |
IV_ONLY_SORTABLE | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Only sortable Common Attributes | 20100225 |
Method READ_CA_BY_CATEGORY_CONNECTOR on class CL_ESH_SEARCH_UI_CA_HELPER has no exception.
History
| Last changed by/on | SAP | 20130531 |
| SAP Release Created in | 730 |
