SAP ABAP Class CL_EAMS_BO_SEARCH_API (search API)
Hierarchy
☛
EA-APPL (Software Component) SAP Enterprise Extension PLM, SCM, Financials
⤷
PM (Application Component) Plant Maintenance
⤷
EAMS_BO_MISC (Package) Miscellaneous for Business Object
EA-APPL (Software Component) SAP Enterprise Extension PLM, SCM, Financials⤷
PM (Application Component) Plant Maintenance⤷
EAMS_BO_MISC (Package) Miscellaneous for Business ObjectProperties
| Class | CL_EAMS_BO_SEARCH_API | |
| Short Description | search API | |
| Super Class | ||
| Instantiability of a Class | 1 | Protected |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | EAMS_BO_MISC | Miscellaneous for Business Object |
| Created | 20090324 | SAP |
| Last change | 20110908 | 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) |
Interfaces
Class CL_EAMS_BO_SEARCH_API has no interface implemented.
Friends
Class CL_EAMS_BO_SEARCH_API has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | GC_DEFAULT_QUERY |
Constant | Public | Type reference (TYPE) | EAMS_D_SEARCH_QUERY_ID | '$!DEFAULT' | Identifier for Search Query | 20090330 | |
| 2 | MO_SEARCH_SRV |
Instance attribute | Protected | Object reference (TYPE REF TO) | CL_EAMS_BO_SEARCH_SRV | Service Classe for Search | 20090402 | ||
| 3 | MO_SRV |
Instance attribute | Protected | Object reference (TYPE REF TO) | CL_EAMS_BO_SRV | Service class for BO | 20090331 | ||
| 4 | MT_QUERY_OBJ_BUFFER |
Static Attribute | Protected | Type reference (TYPE) | GTY_TH_QUERY_OBJ_BUFFER | 20090331 | |||
| 5 | MT_TOTAL_HITS |
Instance attribute | Protected | Type reference (TYPE) | EAMS_T_BO_SEARCH_TOTALHITS | Table Type - total number of hits | 20090417 | ||
| 6 | MV_CURRENT_PAGE |
Instance attribute | Protected | Type reference (TYPE) | I | 20090330 | |||
| 7 | MV_LAST_OBJ_CNT |
Instance attribute | Protected | Type reference (TYPE) | I | 20090330 | |||
| 8 | MV_PAGE_SIZE |
Instance attribute | Protected | Type reference (TYPE) | I | 20090330 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | CONSTRUCTOR |
Instance method | Protected | Constructor | CONSTRUCTOR | 20090324 |
| 2 | GET_FIRST_PAGE |
Instance method | Public | Method | Get first page of result | 20090330 |
| 3 | GET_TOTAL_NUMBER_OF_HITS |
Instance method | Public | Method | 20090417 | |
| 4 | SEARCH_SINGLE_OBJECT |
Instance method | Private | Method | search one business object type | 20090417 |
| 5 | S_GET_INSTANCE |
Static method | Public | Method | Get instance of search api | 20090402 |
Events
Class CL_EAMS_BO_SEARCH_API has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | GTY_S_QUERY_OBJ_BUFFER | Protected | See coding | 20090324 | BEGIN OF gty_s_query_obj_buffer .
TYPES query_id TYPE eams_d_search_query_id.
TYPES o_query TYPE REF TO cl_eams_bo_search_api.
TYPES END OF gty_s_query_obj_buffer
|
||
| 2 | GTY_TH_QUERY_OBJ_BUFFER | Protected | See coding | 20090324 | gty_th_query_obj_buffer TYPE HASHED TABLE OF gty_s_query_obj_buffer
WITH UNIQUE KEY query_id
|
Method Signatures
Method CONSTRUCTOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
IV_QUERY_ID | Call by reference | Type reference (TYPE) | EAMS_D_SEARCH_QUERY_ID | Structure for Query ID | 20090324 |
Method CONSTRUCTOR on class CL_EAMS_BO_SEARCH_API has no exception.
Method GET_FIRST_PAGE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
ET_MESSAGE | Call by reference | Type reference (TYPE) | /PLMB/T_SPI_MSG | Message | 20090330 | ||
| 2 | Exporting |
ET_RESULT_ITEM | Call by reference | Type reference (TYPE) | EAMS_T_SP_SEARCH_RESULT | Table Type - Search Result | 20090330 | ||
| 3 | Exporting |
EV_ERROR | Call by reference | Type reference (TYPE) | ABAP_BOOL | 20090330 | |||
| 4 | Exporting |
EV_FAILED | Call by reference | Type reference (TYPE) | BOOLE_D | Data element for domain BOOLE: TRUE (='X') and FALSE (=' ') | 20090417 | ||
| 5 | Importing |
IT_FIELD_SELOPT | Call by reference | Type reference (TYPE) | EAMS_T_SP_SEARCH_FIELD_SELOPT | Select Options for Search | 20090417 | ||
| 6 | Importing |
IT_SORT_BY | Call by reference | Type reference (TYPE) | /PLMB/T_SPI_SORTORDER | Object Type | 20090330 | ||
| 7 | Importing |
IV_CONNECTOR_ID | Call by reference | Type reference (TYPE) | ESH_E_IF_SEARCH_CONNECTOR_ID | Category ID | 20110128 | ||
| 8 | Importing |
IV_EAMS_OBJECT_TYPE | Call by reference | Type reference (TYPE) | /PLMB/GOS_OBJECT_TYPE | Object Type | 20090417 | ||
| 9 | Importing |
IV_ESH_OBJECT_TYPE | Call by reference | Type reference (TYPE) | ESH_E_OM_OBJECT_TYPE | Object Type | 20090417 | ||
| 10 | Importing |
IV_FUZZY | Call by reference | Type reference (TYPE) | BOOLE_D | Data element for domain BOOLE: TRUE (='X') and FALSE (=' ') | 20090417 | ||
| 11 | Importing |
IV_PAGE_SIZE | Call by reference | Type reference (TYPE) | INT4 | 2 byte integer (signed) | 20090330 | ||
| 12 | Importing |
IV_REQUEST | Call by reference | Type reference (TYPE) | ESH_E_IF_REQUEST_TYPE_ID | Request Type ID | 20090417 | ||
| 13 | Importing |
IV_SEARCH_TERM | Call by reference | Type reference (TYPE) | STRING | 20090417 |
Method GET_FIRST_PAGE on class CL_EAMS_BO_SEARCH_API has no exception.
Method GET_TOTAL_NUMBER_OF_HITS 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) | /PLMB/T_SPI_MSG | Message | 20090417 | ||
| 2 | Exporting |
ET_NODE_DATA | Call by reference | Type reference (TYPE) | EAMS_T_BO_SEARCH_TOTALHITS | Business Object Order - Header Data | 20090417 | ||
| 3 | Exporting |
ET_NODE_ID_REL | Call by reference | Type reference (TYPE) | /PLMB/T_SPI_NODE_REL | Relationship between index of source and target node ID | 20090417 | ||
| 4 | Importing |
IT_NODE_ID | Call by reference | Type reference (TYPE) | EAMS_T_BO_SEARCH_TOTALHITS_ID | Business Object Order - Identification | 20090417 |
Method GET_TOTAL_NUMBER_OF_HITS on class CL_EAMS_BO_SEARCH_API has no exception.
Method SEARCH_SINGLE_OBJECT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_MESSAGE | Call by reference | Type reference (TYPE) | /PLMB/T_SPI_MSG | Message | 20090417 | ||
| 2 | Exporting |
ET_RESULT_ITEM | Call by reference | Type reference (TYPE) | EAMS_T_SP_SEARCH_RESULT | Table Type - Search Result | 20090417 | ||
| 3 | Exporting |
EV_FAILED | Call by reference | Type reference (TYPE) | BOOLE_D | Data element for domain BOOLE: TRUE (='X') and FALSE (=' ') | 20090417 | ||
| 4 | Exporting |
EV_NUMBER_OF_HITS | Call by reference | Type reference (TYPE) | I | 20090417 | |||
| 5 | Exporting |
EV_TOTAL_HITS | Call by reference | Type reference (TYPE) | I | 20090417 | |||
| 6 | Importing |
IT_ES_SORT | Call by reference | Type reference (TYPE) | TREXT_SORT_ATTRIBUTES | Sort attributes | 20090417 | ||
| 7 | Importing |
IT_FIELD_SELOPT | Call by reference | Type reference (TYPE) | EAMS_T_SP_SEARCH_FIELD_SELOPT | Select Options for Search | 20090417 | ||
| 8 | Importing |
IT_TREX_QUERY | Call by reference | Type reference (TYPE) | TREXT_QUERY_ENTRIES | Search query | 20090417 | ||
| 9 | Importing |
IV_CONNECTOR_ID | Call by reference | Type reference (TYPE) | ESH_E_IF_SEARCH_CONNECTOR_ID | Category ID | 20110128 | ||
| 10 | Importing |
IV_EAMS_OBJECT_TYPE | Call by reference | Type reference (TYPE) | /PLMB/GOS_OBJECT_TYPE | Object Type | 20090420 | ||
| 11 | Importing |
IV_ESH_OBJECT_TYPE | Call by reference | Type reference (TYPE) | ESH_E_OM_OBJECT_TYPE | Object Type | 20090417 | ||
| 12 | Importing |
IV_FUZZY | Call by reference | Type reference (TYPE) | BOOLE_D | Data element for domain BOOLE: TRUE (='X') and FALSE (=' ') | 20090417 | ||
| 13 | Importing |
IV_LOWER_PAGE_LIMIT | Call by reference | Type reference (TYPE) | I | 20090417 | |||
| 14 | Importing |
IV_REQUEST | Call by reference | Type reference (TYPE) | ESH_E_IF_REQUEST_TYPE_ID | Request Type ID | 20090417 | ||
| 15 | Importing |
IV_SEARCH_TERM | Call by reference | Type reference (TYPE) | STRING | 20090417 | |||
| 16 | Importing |
IV_UPPER_PAGE_LIMIT | Call by reference | Type reference (TYPE) | I | 20090417 |
Method SEARCH_SINGLE_OBJECT on class CL_EAMS_BO_SEARCH_API has no exception.
Method S_GET_INSTANCE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
EO_QUERY | Call by reference | Object reference (TYPE REF TO) | CL_EAMS_BO_SEARCH_API | search API | 20090402 | ||
| 2 | Exporting |
ET_MESSAGE | Call by reference | Type reference (TYPE) | /PLMB/T_SPI_MSG | Message | 20090402 | ||
| 3 | Exporting |
EV_ERROR | Call by reference | Type reference (TYPE) | ABAP_BOOL | 20090402 | |||
| 4 | Importing |
IV_QUERY_ID | Call by reference | Type reference (TYPE) | EAMS_D_SEARCH_QUERY_ID | Structure for Query ID | 20090402 |
Method S_GET_INSTANCE on class CL_EAMS_BO_SEARCH_API has no exception.
History
| Last changed by/on | SAP | 20110908 |
| SAP Release Created in | 605 |
