SAP ABAP Class CL_ESH_QL_DATA_PROVIDER (Implementation of TEST_MATERIAL)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-EIM-ESH (Application Component) NetWeaver Enterprise Search
⤷
S_ESH_ENG_QUERY_LOGGING (Package) Query Logging
SAP_BASIS (Software Component) SAP Basis Component⤷
BC-EIM-ESH (Application Component) NetWeaver Enterprise Search⤷
S_ESH_ENG_QUERY_LOGGING (Package) Query LoggingMeta Relationship - Using
Properties
| Class | CL_ESH_QL_DATA_PROVIDER | |
| Short Description | Implementation of TEST_MATERIAL | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | S_ESH_ENG_QUERY_LOGGING | Query Logging |
| Created | 20100125 | SAP |
| Last change | 20110908 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
Class CL_ESH_QL_DATA_PROVIDER has no forward declaration.
Interfaces
| # | Interface | Abstract | Final | Description | Created on |
|---|---|---|---|---|---|
| 1 | IF_ESH_IF_DATA_PROVIDER | Data provider | 20100125 | ||
| 2 | IF_ESH_IF_DATA_PROVIDER_INCL | Instances of included interfaces of data provider | 20100125 | ||
| 3 | IF_ESH_IF_OBJECT_DATA_BY_ID | Object data by list of object ids | 20100125 | ||
| 4 | IF_ESH_IF_OBJECT_DESCRIPTOR | Object type descriptor | 20100125 | ||
| 5 | IF_ESH_IF_OBJECT_ITERATOR | Object data iterator by last object id | 20100125 | ||
| 6 | IF_ESH_IF_OBJECT_ITERATOR_TIME | Object data iterator by last timestamp | 20100125 | ||
| 7 | IF_ESH_IF_OBJECT_TYPES_LIST | Object type list | 20100125 | ||
| 8 | IF_ESH_IF_OBJECT_TYPE_BY_ID | Object type by ID | 20100125 |
Friends
Class CL_ESH_QL_DATA_PROVIDER has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | GC_DATA_PROVIDER_CLASS |
Constant | Public | Type reference (TYPE) | SEOCLSNAME | 'CL_ESH_QL_DATA_PROVIDER' | Data provider class | 20100125 | |
| 2 | GC_HOME_SOFTWARE_COMPONENT |
Constant | Public | Type reference (TYPE) | ESH_E_OM_SYSREL | 'ESH_SERVICES' | Home software component ESH_SERVICES | 20100125 | |
| 3 | GC_NODE_NAME_QUERY_LOG |
Constant | Public | Type reference (TYPE) | ESH_E_OM_NODE_NAME | 'QUERY_LOG' | Object ESH_QUERY_LOG: Node QUERY_LOG | 20100125 | |
| 4 | GC_NODE_NAME_ST_STAT |
Constant | Public | Type reference (TYPE) | ESH_E_OM_NODE_NAME | 'ST_STAT' | Object ESH_SEARCHTERM_STAT: Node ST_STAT | 20100127 | |
| 5 | GC_OBJECT_TYPE_ESH_QUERY_LOG |
Constant | Public | Type reference (TYPE) | ESH_E_OM_OBJECT_TYPE | 'ESH_QUERY_LOG' | Object type ESH_QUERY_LOG | 20100125 | |
| 6 | GC_OBJECT_TYPE_ESH_ST_STAT |
Constant | Public | Type reference (TYPE) | ESH_E_OM_OBJECT_TYPE | 'ESH_SEARCHTERM_STAT' | Object type ESH_SEARCHTERM_STAT | 20100127 | |
| 7 | GC_QL_AGGREG_PREPARE_CLASS |
Constant | Public | Type reference (TYPE) | SEOCLSNAME | 'CL_ESH_QL_AGGREG_PREPARE' | Query log aggregator: Class implementing preparation step | 20100805 | |
| 8 | MR_LOG_EXTRACTOR |
Instance attribute | Private | Object reference (TYPE REF TO) | CL_ESH_QL_QUERY_LOG_EXPORT | Query log export tools | 20100125 | ||
| 9 | MR_SEARCHTERM_STATISTICS |
Instance attribute | Private | Object reference (TYPE REF TO) | CL_ESH_QL_SEARCHTERM_STAT | Searchterm statistics handler | 20100127 | ||
| 10 | MV_HOME_SOFTWARE_COMPONENT |
Instance attribute | Private | Type reference (TYPE) | ESH_E_OM_SYSREL | Home software component | 20100125 | ||
| 11 | MV_OBJECT_TYPE |
Instance attribute | Private | Type reference (TYPE) | ESH_E_OM_OBJECT_TYPE | Object type | 20100125 | ||
| 12 | MV_TERMBASED_ONLY |
Instance attribute | Private | Type reference (TYPE) | ESH_E_CO_BOOLEAN | Extract term-based entries only | 20100125 | ||
| 13 | ST_DATA_PROVIDERS |
Static Attribute | Private | Type reference (TYPE) | LTT_DATA_PROVIDERS | 20100126 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | QUERY_LOG_PROCESS_GET_DATA |
Instance method | Protected | Method | Query log: Process 'Get Data' | 20100125 |
| 2 | QUERY_LOG_PROCESS_NEXT |
Instance method | Protected | Method | Query log: Process 'Next' | 20100125 |
| 3 | QUERY_LOG_PROCESS_NEXT_BY_TIME |
Instance method | Protected | Method | Query log: Process 'Next' (time-based) | 20100125 |
| 4 | SET_INSTANCE_ATTRIBUTES |
Instance method | Private | Method | Set instance attributes | 20100125 |
| 5 | ST_STAT_PROCESS_GET_DATA |
Instance method | Protected | Method | Search term statistics: Process 'Get Data' | 20100127 |
| 6 | ST_STAT_PROCESS_NEXT |
Instance method | Protected | Method | Search term statistics: Process 'Next' | 20100127 |
| 7 | ST_STAT_PROCESS_NEXT_BY_TIME |
Instance method | Protected | Method | Search term statistics: Process 'Next' (time-based) | 20100127 |
Events
Class CL_ESH_QL_DATA_PROVIDER has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | LTT_DATA_PROVIDERS | Private | See coding | 20100126 | LTT_DATA_PROVIDERS type sorted table of lty_data_providers with unique key HOME_SOFTWARE_COMPONENT OBJECT_TYPE
|
||
| 2 | LTY_DATA_PROVIDERS | Private | See coding | 20100126 | begin of LTY_DATA_PROVIDERS ,
home_software_component TYPE esh_e_om_sysrel,
object_type TYPE esh_e_om_object_type,
data_provider TYPE REF TO cl_esh_ql_data_provider ,
end of LTY_DATA_PROVIDERS
|
Method Signatures
Method QUERY_LOG_PROCESS_GET_DATA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
ET_MESSAGES | Call by reference | Type reference (TYPE) | BAPIRETTAB | Feedback on global extract execution level | 20100125 | ||
| 2 | Exporting |
ET_OBJECT_FEEDBACK | Call by reference | Type reference (TYPE) | ESH_T_IF_OBJECT_FEEDBACK | Feedback for objects which could not be extracted | 20100125 | ||
| 3 |  Importing |
IT_OBJECT_EXTRACTION | Call by reference | Type reference (TYPE) | ESH_T_IF_EXTRACT_NODES | Extraction of nodes | 20100125 | ||
| 4 | Importing |
IT_OBJECT_IDS | Call by reference | Type reference (TYPE) | ESH_T_IF_CHANGED_OBJECTS | Changed Objects | 20100125 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CX_ESH_IF_PROVIDER_ERROR |
General error in provider | 20100125 |
Method QUERY_LOG_PROCESS_NEXT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_MESSAGES | Call by reference | Type reference (TYPE) | BAPIRETTAB | Return Messages | 20100125 | ||
| 2 | Exporting |
EV_LAST_OBJECT_ID | Call by reference | Type reference (TYPE) | ESH_E_IF_SEARCH_EXEC_ID | Last Object ID | 20100125 | ||
| 3 | Exporting |
EV_NO_MORE_DATA | Call by reference | Type reference (TYPE) | CHAR01 | No More Data | 20100125 | ||
| 4 | Importing |
IT_OBJECT_EXTRACTION | Call by reference | Type reference (TYPE) | ESH_T_IF_EXTRACT_NODES | Extraction of nodes | 20100125 | ||
| 5 | Importing |
IV_LAST_OBJECT_ID | Call by reference | Type reference (TYPE) | ESH_E_IF_SEARCH_EXEC_ID | Start Object ID | 20100125 | ||
| 6 | Importing |
IV_PACKAGE_SIZE | Call by reference | Type reference (TYPE) | ESH_E_IF_PACKAGE_SIZE | Package size | 20100125 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_ESH_IF_PROVIDER_ERROR |
General error in provider | 20100125 |
Method QUERY_LOG_PROCESS_NEXT_BY_TIME Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_MESSAGES | Call by reference | Type reference (TYPE) | BAPIRETTAB | Return Messages | 20100125 | ||
| 2 | Exporting |
EV_LAST_TIMESTAMP | Call by reference | Type reference (TYPE) | TIMESTAMPL | Last Execution Timestamp | 20100125 | ||
| 3 | Exporting |
EV_NO_MORE_DATA | Call by reference | Type reference (TYPE) | CHAR01 | No More Data | 20100125 | ||
| 4 | Importing |
IT_OBJECT_EXTRACTION | Call by reference | Type reference (TYPE) | ESH_T_IF_EXTRACT_NODES | Extraction of nodes | 20100125 | ||
| 5 | Importing |
IV_LAST_TIMESTAMP | Call by reference | Type reference (TYPE) | TIMESTAMPL | Start Execution Timestamp | 20100125 | ||
| 6 | Importing |
IV_PACKAGE_SIZE | Call by reference | Type reference (TYPE) | ESH_E_IF_PACKAGE_SIZE | Package size | 20100125 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_ESH_IF_PROVIDER_ERROR |
General error in provider | 20100125 |
Method SET_INSTANCE_ATTRIBUTES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_HOME_SOFTWARE_COMPONENT | Call by reference | Type reference (TYPE) | ESH_E_OM_SYSREL | Original software component of the object type | 20100125 | ||
| 2 | Importing |
IV_OBJECT_TYPE_BACKEND_NAME | Call by reference | Type reference (TYPE) | ESH_E_OM_BACKEND_NAME | Backend Name | 20100125 | ||
| 3 | Importing |
IV_OBJECT_TYPE_ID | Call by reference | Type reference (TYPE) | ESH_E_OM_OBJECT_TYPE | Object Type | 20100125 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_ESH_IF_PROVIDER_ERROR |
General error in provider | 20100125 |
Method ST_STAT_PROCESS_GET_DATA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_MESSAGES | Call by reference | Type reference (TYPE) | BAPIRETTAB | Feedback on global extract execution level | 20100127 | ||
| 2 | Exporting |
ET_OBJECT_FEEDBACK | Call by reference | Type reference (TYPE) | ESH_T_IF_OBJECT_FEEDBACK | Feedback for objects which could not be extracted | 20100127 | ||
| 3 | Importing |
IT_OBJECT_EXTRACTION | Call by reference | Type reference (TYPE) | ESH_T_IF_EXTRACT_NODES | Extraction of nodes | 20100127 | ||
| 4 | Importing |
IT_OBJECT_IDS | Call by reference | Type reference (TYPE) | ESH_T_IF_CHANGED_OBJECTS | Changed Objects | 20100127 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_ESH_IF_PROVIDER_ERROR |
General error in provider | 20100127 |
Method ST_STAT_PROCESS_NEXT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_MESSAGES | Call by reference | Type reference (TYPE) | BAPIRETTAB | Return Messages | 20100127 | ||
| 2 | Exporting |
EV_LAST_KEY | Call by reference | Type reference (TYPE) | ESH_E_QL_HKY | Last Entry Key | 20100127 | ||
| 3 | Exporting |
EV_NO_MORE_DATA | Call by reference | Type reference (TYPE) | CHAR01 | No More Data | 20100127 | ||
| 4 | Importing |
IT_OBJECT_EXTRACTION | Call by reference | Type reference (TYPE) | ESH_T_IF_EXTRACT_NODES | Extraction of nodes | 20100127 | ||
| 5 | Importing |
IV_FROM_KEY | Call by reference | Type reference (TYPE) | ESH_E_QL_HKY | Start Entry Key | 20100127 | ||
| 6 | Importing |
IV_PACKAGE_SIZE | Call by reference | Type reference (TYPE) | ESH_E_IF_PACKAGE_SIZE | Package size | 20100127 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_ESH_IF_PROVIDER_ERROR |
General error in provider | 20100127 |
Method ST_STAT_PROCESS_NEXT_BY_TIME Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_MESSAGES | Call by reference | Type reference (TYPE) | BAPIRETTAB | Return Messages | 20100127 | ||
| 2 | Exporting |
EV_LAST_TIMESTAMP | Call by reference | Type reference (TYPE) | TIMESTAMPL | Last Execution Timestamp | 20100127 | ||
| 3 | Exporting |
EV_NO_MORE_DATA | Call by reference | Type reference (TYPE) | CHAR01 | No More Data | 20100127 | ||
| 4 | Importing |
IT_OBJECT_EXTRACTION | Call by reference | Type reference (TYPE) | ESH_T_IF_EXTRACT_NODES | Extraction of nodes | 20100127 | ||
| 5 | Importing |
IV_FROM_TIMESTAMP | Call by reference | Type reference (TYPE) | TIMESTAMPL | Start Execution Timestamp | 20100127 | ||
| 6 | Importing |
IV_PACKAGE_SIZE | Call by reference | Type reference (TYPE) | ESH_E_IF_PACKAGE_SIZE | Package size | 20100127 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_ESH_IF_PROVIDER_ERROR |
General error in provider | 20100127 |
History
| Last changed by/on | SAP | 20110908 |
| SAP Release Created in | 730 |
