SAP ABAP Interface IF_FIND_DOCS_BY_ELEMENTS (Interface for Document Search Classes)
Hierarchy
☛
SAP_APPL (Software Component) Logistics and Accounting
⤷
CA (Application Component) Cross-Application Components
⤷
CA_DOC_SEARCH_FRAMEWORK (Package) Cross Application Tools - Search Wrapper Base
SAP_APPL (Software Component) Logistics and Accounting⤷
CA (Application Component) Cross-Application Components⤷
CA_DOC_SEARCH_FRAMEWORK (Package) Cross Application Tools - Search Wrapper Base
Meta Relationship - Used By
Properties
| Interface | IF_FIND_DOCS_BY_ELEMENTS | |
| Short Description | Interface for Document Search Classes |
General Data
| Package | CA_DOC_SEARCH_FRAMEWORK | Cross Application Tools - Search Wrapper Base |
| Created | 20100805 | SAP |
| Last changed | 20110908 | SAP |
| 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
Interface IF_FIND_DOCS_BY_ELEMENTS has no interface.
Friends
Interface IF_FIND_DOCS_BY_ELEMENTS has no friend.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | C_CHECK_SELECTION | Constant | Public | Type reference (TYPE) | PARAMETER | 'CHECK' | Selection Type 'CHECK' | 20100805 | |
| 2 | C_GET_SELECTION | Constant | Public | Type reference (TYPE) | PARAMETER | 'GET' | Selection Type 'GET' | 20100805 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | CHECK_DOCS_BY |
Instance method | Public | Method | Checks Documents for Element | 20100805 |
| 2 | GET_DOCS_BY |
Instance method | Public | Method | Returns Documents for Element | 20100805 |
| 3 | GET_INSTANCE |
Static method | Public | Method | Returns Relevant Object Instance | 20100805 |
Events
Interface IF_FIND_DOCS_BY_ELEMENTS has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | TCS_FIND_DOCS_BY_INSTANCE | Public | See coding | 20100805 | BEGIN OF tcs_find_docs_by_instance,
instance_name TYPE string,
obj_type TYPE parameter,
sel_type TYPE parameter,
cls_name type classname,
instance TYPE REF TO if_find_docs_by_elements,
END OF tcs_find_docs_by_instance
|
||
| 2 | TCS_KEY_TYPE | Public | See coding | 20100805 | BEGIN OF tcs_key_type,
instance_name TYPE string,
obj_type TYPE parameter,
END OF tcs_key_type
|
||
| 3 | TCT_FIND_DOCS_BY_INSTANCE | Public | See coding | 20100805 | tct_find_docs_by_instance TYPE STANDARD TABLE OF tcs_find_docs_by_instance
|
||
| 4 | TCT_KEY_TYPE | Public | See coding | 20100805 | tct_key_type TYPE STANDARD TABLE OF tcs_key_type
|
Method Signatures
Method CHECK_DOCS_BY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
EV_CHECK_OK | Call by reference | Type reference (TYPE) | FLAG | Flag: Check OK | 20100805 | ||
| 2 |  Importing |
IO_SW_DOC | Call by reference | Object reference (TYPE REF TO) | IF_DOC_SEARCH_WRAPPER | Interface for Document Search Wrapper Class | 20100805 | ||
| 3 | Importing |
IS_CUR_RES_LINE | Call by reference | Type reference (TYPE) | DATA | Currently Processed Result Line from Selection | 20100901 | ||
| 4 | Importing |
IT_DILATE_SELECT | Call by reference | Type reference (TYPE) | TDT_SW_DILATE_SELECT | Additional WHERE Clause Statements for FIND_BY Classes | 20100805 | ||
| 5 | Importing |
IT_KEY_DEF | Call by reference | Type reference (TYPE) | WDY_KEY_VALUE_LIST | List of key definitions | 20100909 | ||
| 6 | Importing |
IV_INSTANCE_NAME | Call by reference | Type reference (TYPE) | STRING | Instance Name | 20100909 | ||
| 7 | Importing |
IV_OBJ_TYPE | Call by reference | Type reference (TYPE) | PARAMETER | Object Type | 20100901 |
Method CHECK_DOCS_BY on Interface IF_FIND_DOCS_BY_ELEMENTS has no exception.
Method GET_DOCS_BY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Changing |
CT_KEY_HEAD | Call by reference | Type reference (TYPE) | SORTED TABLE | Table of Retrieved Document Keys | 20100909 | ||
| 2 | Changing |
CT_PROCESSED | Call by reference | Type reference (TYPE) | TCT_KEY_TYPE | Selections Already Made | 20100805 | ||
| 3 | Exporting |
EV_PROCESSED | Call by reference | Type reference (TYPE) | FLAG | Flag: Search Executed | 20100805 | ||
| 4 | Importing |
IO_SW_DOC | Call by reference | Object reference (TYPE REF TO) | IF_DOC_SEARCH_WRAPPER | Interface for Document Search Wrapper Class | 20100805 | ||
| 5 | Importing |
IT_DILATE_SELECT | Call by reference | Type reference (TYPE) | TDT_SW_DILATE_SELECT | Additional WHERE Clause Statements for FIND_BY Classes | 20100805 | ||
| 6 | Importing |
IT_KEY_DEF | Call by reference | Type reference (TYPE) | WDY_KEY_VALUE_LIST | List of key definitions | 20100909 | ||
| 7 | Importing |
IV_INSTANCE_NAME | Call by reference | Type reference (TYPE) | STRING | Instance Name | 20100909 | ||
| 8 | Importing |
IV_OBJ_TYPE | Call by reference | Type reference (TYPE) | PARAMETER | Object Type | 20100901 |
Method GET_DOCS_BY on Interface IF_FIND_DOCS_BY_ELEMENTS has no exception.
Method GET_INSTANCE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
ET_FIND_BY_INST | Call by reference | Type reference (TYPE) | TCT_FIND_DOCS_BY_INSTANCE | Table of Object Instances | 20100805 | ||
| 2 | Importing |
IO_SW_DOC | Call by reference | Object reference (TYPE REF TO) | IF_DOC_SEARCH_WRAPPER | Interface for Document Search Wrapper Class | 20100805 | ||
| 3 | Importing |
IT_DILATE_SELECT | Call by reference | Type reference (TYPE) | TDT_SW_DILATE_SELECT | Additional WHERE Clause Statements for FIND_BY Classes | 20100805 | ||
| 4 | Importing |
IT_KEY_DEF | Call by reference | Type reference (TYPE) | WDY_KEY_VALUE_LIST | List of key definitions | 20100909 | ||
| 5 | Importing |
IV_SEARCH_WRAPPER_CLS | Call by reference | Type reference (TYPE) | ABAP_ABSTYPENAME | Search Wrapper class that is initiating the request | 20100809 | ||
| 6 | Importing |
IV_USECASE_ID | Call by reference | Type reference (TYPE) | TDD_SW_USECASE_ID | Searchwrapper Usecase ID | 20101221 | ||
| 7 | Importing |
IV_WRAPPER_ID | Call by reference | Type reference (TYPE) | CHAR10 | Identifies implementing search wrapper class | 20100831 |
Method GET_INSTANCE on Interface IF_FIND_DOCS_BY_ELEMENTS has no exception.
Meta Relationship - Used By (full list)
History
| Last changed by/on | SAP | 20110908 |
| SAP Release Created in | 606 |
