SAP ABAP Class CL_DOC_SEARCH_WRAPPER_BASE (Abstract Wrapper Class for Document Search)
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
⤷ CA (Application Component) Cross-Application Components
⤷ CA_DOC_SEARCH_FRAMEWORK (Package) Cross Application Tools - Search Wrapper Base
Meta Relationship - Using
# | Relationship type | Using | Short Description | Created on |
---|---|---|---|---|
1 | Interface implementation (CLASS c. INTERFACES i_ref) | IF_DOC_SEARCH_WRAPPER | Interface for Document Search Wrapper Class | 20100805 |
Meta Relationship - Used By
# | Relationship type | Used by | Short Description | Created on |
---|---|---|---|---|
1 | Inheritance (c INHERITING FROM c_ref) | CL_DOC_SEARCH_WRAPPER_BIL | Search Wrapper for Billing Documents | 20100805 |
2 | Inheritance (c INHERITING FROM c_ref) | CL_DOC_SEARCH_WRAPPER_SHP | Search Wrapper for Shipping Documents | 20100817 |
Properties
Class | CL_DOC_SEARCH_WRAPPER_BASE | |
Short Description | Abstract Wrapper Class for Document Search | |
Super Class | ||
Instantiability of a Class | 2 | Public |
Final |
General Data
Message Class | ||
Program status | ||
Category | 0 | |
Package | CA_DOC_SEARCH_FRAMEWORK | Cross Application Tools - Search Wrapper Base |
Created | 20100804 | 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) |
2 | IF_FIND_DOCS_BY_ELEMENTS | Forward declaration interface (INTERFACE i DEFINITION DEF... | Forward declaration interface (INTERFACE i DEFINITION DEF... |
3 | SEOR | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
4 | ZIF_FIND_DOCS_BY_ELEMENTS | Forward declaration interface (INTERFACE i DEFINITION DEF... | Forward declaration interface (INTERFACE i DEFINITION DEF... |
Interfaces
# | Interface | Abstract | Final | Description | Created on |
---|---|---|---|---|---|
1 | IF_DOC_SEARCH_WRAPPER | Interface for Document Search Wrapper Class | 20100805 |
Friends
Class CL_DOC_SEARCH_WRAPPER_BASE has no friend class.
Attributes
# | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | HEAD | Instance attribute | Protected | Attribute reference (LIKE) | 20100810 | ||||
2 | ITEM | Instance attribute | Protected | Attribute reference (LIKE) | 20100810 | ||||
3 | MO_KEY_PACK_HEAD | Instance attribute | Protected | Object reference (TYPE REF TO) | DATA | 20100908 | |||
4 | MO_KEY_TAB_HEAD | Instance attribute | Protected | Object reference (TYPE REF TO) | DATA | 20100809 | |||
5 | MO_KEY_TAB_ITEM | Instance attribute | Protected | Object reference (TYPE REF TO) | DATA | 20100809 | |||
6 | MO_RANGE_CONTAINER | Instance attribute | Private | Object reference (TYPE REF TO) | DATA | 20100805 | |||
7 | MO_SELCRIT | Instance attribute | Private | Object reference (TYPE REF TO) | DATA | Selection Criteria | 20100805 | ||
8 | MO_SELECT_LINE | Instance attribute | Protected | Object reference (TYPE REF TO) | DATA | 20100908 | |||
9 | MO_SELECT_LINE_ITEM | Instance attribute | Protected | Object reference (TYPE REF TO) | DATA | 20100908 | |||
10 | MO_STRUCT_DESCR | Instance attribute | Private | Object reference (TYPE REF TO) | CL_ABAP_STRUCTDESCR | 20100805 | |||
11 | MS_KEY_DEF_HEAD | Instance attribute | Protected | Type reference (TYPE) | TCS_KEY_DEF | 20100908 | |||
12 | MS_KEY_DEF_ITEM | Instance attribute | Protected | Type reference (TYPE) | TCS_KEY_DEF | 20100908 | |||
13 | MT_ADD_CONTENT | Instance attribute | Private | Type reference (TYPE) | TCT_ADD_CONTENT | Standard list of key/value relationships as strings | 20100901 | ||
14 | MT_CHECK_INST_HEAD | Instance attribute | Private | Type reference (TYPE) | IF_FIND_DOCS_BY_ELEMENTS=>TCT_FIND_DOCS_BY_INSTANCE | 20100908 | |||
15 | MT_CHECK_INST_ITEM | Instance attribute | Private | Type reference (TYPE) | IF_FIND_DOCS_BY_ELEMENTS=>TCT_FIND_DOCS_BY_INSTANCE | 20100908 | |||
16 | MT_DILATE_SELECT_FIND_BY | Instance attribute | Private | Type reference (TYPE) | TDT_SW_DILATE_SELECT | Additional WHERE Clause Statements for FIND_BY Classes | 20100908 | ||
17 | MT_DILATE_SELECT_HEAD | Instance attribute | Protected | Type reference (TYPE) | TDT_SW_SEL_CONDITION | Additional WHERE Clause Statements for Head Selection | 20100908 | ||
18 | MT_DILATE_SELECT_ITEM | Instance attribute | Protected | Type reference (TYPE) | TDT_SW_SEL_CONDITION | Additional WHERE Clause Statements for Item Selection | 20100908 | ||
19 | MT_GET_INST_HEAD | Instance attribute | Private | Type reference (TYPE) | IF_FIND_DOCS_BY_ELEMENTS=>TCT_FIND_DOCS_BY_INSTANCE | 20100908 | |||
20 | MT_GET_INST_ITEM | Instance attribute | Private | Type reference (TYPE) | IF_FIND_DOCS_BY_ELEMENTS=>TCT_FIND_DOCS_BY_INSTANCE | 20100908 | |||
21 | MT_IMPKEY | Instance attribute | Private | Type reference (TYPE) | SEOR_IMPLEMENTING_KEYS | 20110220 | |||
22 | MT_KEY_DEF | Instance attribute | Protected | Type reference (TYPE) | WDY_KEY_VALUE_LIST | 20100909 | |||
23 | MT_MSG_LOG | Instance attribute | Protected | Type reference (TYPE) | TDT_SW_MSG | 20100805 | |||
24 | MT_PROCESSED | Instance attribute | Protected | Type reference (TYPE) | IF_FIND_DOCS_BY_ELEMENTS=>TCT_KEY_TYPE | 20100805 | |||
25 | MV_COUNT | Instance attribute | Protected | Type reference (TYPE) | TBMAXSEL | 0 | 20100805 | ||
26 | MV_FINDBY_INTERFACE_NAME | Instance attribute | Protected | Type reference (TYPE) | STRING | Name of Interface for Document Search Classes | 20101220 | ||
27 | MV_ITEMSEL_REQ | Instance attribute | Protected | Type reference (TYPE) | FLAG | SPACE | Flag: Selection on Item Level Required | 20100805 | |
28 | MV_ITEM_REQ | Instance attribute | Protected | Type reference (TYPE) | FLAG | SPACE | Flag: Output of Item Data is Requested | 20100805 | |
29 | MV_KEY_HEAD_ITEM_REQ | Instance attribute | Protected | Type reference (TYPE) | FLAG | SPACE | Flag: ET_RESULTS_ITEM is requested | 20100909 | |
30 | MV_KEY_HEAD_REQ | Instance attribute | Protected | Type reference (TYPE) | FLAG | SPACE | Flag: ET_RESULTS_HEAD is requested | 20100909 | |
31 | MV_MAXSEL | Instance attribute | Protected | Type reference (TYPE) | TBMAXSEL | 0 | Maximum Number of Documents to be Selected | 20100805 | |
32 | MV_MORE_ENTRIES_REQ | Instance attribute | Protected | Type reference (TYPE) | FLAG | SPACE | Flag: EV_MORE_ENTRIES is requested | 20100909 | |
33 | MV_MY_CLS_NAME | Instance attribute | Protected | Type reference (TYPE) | ABAP_ABSTYPENAME | My class name | 20100809 | ||
34 | MV_RES_HEAD_REQ | Instance attribute | Protected | Type reference (TYPE) | FLAG | SPACE | Flag: ET_RESULTS_HEAD is requested | 20100909 | |
35 | MV_RES_ITEM_REQ | Instance attribute | Protected | Type reference (TYPE) | FLAG | SPACE | Flag: ET_KEY_HEAD_ITEM is requested | 20100909 | |
36 | MV_USECASE_ID | Instance attribute | Protected | Type reference (TYPE) | TDD_SW_USECASE_ID | Usecase ID based on Domain | 20101221 | ||
37 | MV_WRAPPER_ID | Instance attribute | Protected | Type reference (TYPE) | CHAR10 | Identifies implementing search wrapper class | 20100831 |
Methods
# | Method | Level | Visibility | Method type | Description | Created on |
---|---|---|---|---|---|---|
1 | CHECK_AND_TRANSFER_MAIN | Instance method | Protected | Method | Validates the current result line, moves it to result struc | 20100809 |
2 | CHECK_AND_TRANSFER_MAIN_ITEM | Instance method | Protected | Method | Validates the current result line, moves it to result struc | 20100809 |
3 | CONSTRUCTOR | Instance method | Public | Constructor | Constructor to be redifined by inheriting classes | 20100809 |
4 | DETERMINE_SELECTION_SEQ | Instance method | Protected | Method | Determines sequence in which data selection is carried out | 20100804 |
5 | DO_ASSIGNMENT | Instance method | Private | Method | Assignment of results based on assignment rules | 20100804 |
6 | FREE_DATA | Instance method | Protected | Method | Initializes Selection-Dependent Data | 20100804 |
7 | GET_DESCR | Instance method | Protected | Method | Returns Descriptive Texts | 20100804 |
8 | GET_DOCUMENTS | Instance method | Public | Method | Returns documents that match the selection criteria | 20100804 |
9 | GET_FIND_BY_INSTANCES | Instance method | Private | Method | Returns 'IF_FIND_DOCS_BY_ELEMENTS' Instances | 20100804 |
10 | GET_HEAD_VALUE_DESCR | Instance method | Protected | Method | Returns Descriptive Texts for Requested Fields | 20100804 |
11 | GET_MAIN | Instance method | Protected | Method | Table selection (Head) | 20100804 |
12 | GET_MAIN_ITEM | Instance method | Protected | Method | Table selection (Item) | 20100804 |
13 | GET_NEXT_RESULT_PACK | Instance method | Public | Method | Returns next results based on IV_MAXSEL | 20100804 |
14 | INPUT_VALIDATION | Instance method | Protected | Method | Input validation | 20100804 |
15 | MAP_RESULTS | Instance method | Protected | Method | Assignment of Data to the Specified Results Area | 20100804 |
16 | MOVE_RESULTS | Instance method | Protected | Method | Move data without assignment rule to specified results area | 20100810 |
17 | PERFORM_SYNTAX_CHECK | Static method | Private | Method | Perform a syntax check for the given ABAP class | 20100908 |
18 | SEARCH_DOCUMENTS | Instance method | Private | Method | Document Search | 20100804 |
19 | SET_KEY_DEFINITION | Instance method | Protected | Method | Sets Key Information for Head and Item | 20100809 |
Events
Class CL_DOC_SEARCH_WRAPPER_BASE has no event.
Types
# | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
---|---|---|---|---|---|---|---|
1 | TCS_ADD_CONTENT | Protected | Attribute reference (LIKE) | 20100901 |
|
||
2 | TCS_KEY_DEF | Protected | See coding | 20100907 | begin of tcs_key_def,
key_dtype_parent type field_type, " DDIC data type of parent key
key_dtype type field_type, " DDIC data type of key
key_tabname type tabname, " DDIC table name for ET_KEY_HEAD / ET_KEY_HEAD_ITEM
key_name_parent type fieldname, " Fieldname of parent key in ET_KEY_HEAD_ITEM
key_name type fieldname, " Fieldname of key in ET_KEY_HEAD / ET_KEY_HEAD_ITEM
key_name_res_parent type fieldname, " Fieldname of parent key in ET_RESULTS_ITEM
key_name_res type fieldname, " Fieldname of key in ET_RESULTS_*
key_name_sel_parent type fieldname, " Fieldname of parent key in selection table
key_name_sel type fieldname, " Fieldname of key in selection table
end of tcs_key_def
|
||
3 | TCT_ADD_CONTENT | Protected | Attribute reference (LIKE) | 20100901 |
|
||
4 | TCT_STRING | Protected | Attribute reference (LIKE) | 20100901 |
|
Method Signatures
Method CHECK_AND_TRANSFER_MAIN Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Exporting | ET_KEY_HEAD | Call by reference | Type reference (TYPE) | SORTED TABLE | Table of Retrieved Document Keys | 20100809 | ||
2 | Exporting | ET_RESULTS_HEAD | Call by reference | Type reference (TYPE) | STANDARD TABLE | Application-Specific Output Table (Header Data) | 20100908 | ||
3 | Exporting | ET_VALUE_DESCR_HEAD | Call by reference | Type reference (TYPE) | TDT_VALUE_DESCR | Table of Retrieved Descriptions | 20100908 | ||
4 | Importing | IT_MAP_FIELDS | Call by reference | Type reference (TYPE) | TDT_SW_MAP_FIELDS | Mapping Table for Output Fields of Document Search | 20100809 | ||
5 | Importing | IT_REQUEST_DESCR_HEAD | Call by reference | Type reference (TYPE) | TDT_FIELDNAME | Table of Requested Descriptions | 20100908 | ||
6 | Importing | IT_SELECT_RES | Call by reference | Type reference (TYPE) | STANDARD TABLE | Results from main selection | 20100809 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CX_DOC_SEARCH_WRAPPER | Exception Class for Search Wrapper API | 20100908 |
Method CHECK_AND_TRANSFER_MAIN_ITEM 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 | 20100906 | ||
2 | Changing | CT_RESULTS_HEAD | Call by reference | Type reference (TYPE) | STANDARD TABLE | Application-Specific Output Table (Header Data) | 20100908 | ||
3 | Exporting | ET_KEY_HEAD_ITEM | Call by reference | Type reference (TYPE) | SORTED TABLE | Table of Retrieved Document Head-Item Keys | 20100831 | ||
4 | Exporting | ET_RESULTS_ITEM | Call by reference | Type reference (TYPE) | STANDARD TABLE | Application-Specific Output Table (Item Data) | 20100831 | ||
5 | Exporting | EV_KEY_DEL_HEAD | Call by reference | Type reference (TYPE) | DATA | Key to be Deleted from Result Table | 20100908 | ||
6 | Importing | IT_MAP_FIELDS | Call by reference | Type reference (TYPE) | TDT_SW_MAP_FIELDS | Mapping Table for Output Fields of Document Search | 20100831 | ||
7 | Importing | IT_SELECT_RES | Call by reference | Type reference (TYPE) | STANDARD TABLE | Results from main item selection | 20100831 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CX_DOC_SEARCH_WRAPPER | Exception Class for Search Wrapper API | 20100908 |
Method CONSTRUCTOR Signature
Method CONSTRUCTOR on class CL_DOC_SEARCH_WRAPPER_BASE has no parameter.
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CX_DOC_SEARCH_WRAPPER | Exception Class for Search Wrapper API | 20100909 |
Method DETERMINE_SELECTION_SEQ Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Exporting | ET_CHECK_DOCS_HEAD_INST | Call by reference | Type reference (TYPE) | IF_FIND_DOCS_BY_ELEMENTS=>TCT_FIND_DOCS_BY_INSTANCE | 20100810 | |||
2 | Exporting | ET_CHECK_DOCS_ITEM_INST | Call by reference | Type reference (TYPE) | IF_FIND_DOCS_BY_ELEMENTS=>TCT_FIND_DOCS_BY_INSTANCE | 20100810 | |||
3 | Exporting | ET_GET_DOCS_HEAD_INST | Call by reference | Type reference (TYPE) | IF_FIND_DOCS_BY_ELEMENTS=>TCT_FIND_DOCS_BY_INSTANCE | 20100810 | |||
4 | Exporting | ET_GET_DOCS_ITEM_INST | Call by reference | Type reference (TYPE) | IF_FIND_DOCS_BY_ELEMENTS=>TCT_FIND_DOCS_BY_INSTANCE | 20100810 | |||
5 | Importing | IT_FIND_BY_INSTANCES | Call by reference | Type reference (TYPE) | IF_FIND_DOCS_BY_ELEMENTS=>TCT_FIND_DOCS_BY_INSTANCE | 20100805 | |||
6 | Importing | IV_USECASE_ID | Call by reference | Type reference (TYPE) | TDD_SW_USECASE_ID | Searchwrapper Usecase ID | 20101221 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CX_DOC_SEARCH_WRAPPER | Exception Class for Search Wrapper API | 20100908 |
Method DO_ASSIGNMENT Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Exporting | EV_VALUE_EXT | Call by reference | Type reference (TYPE) | DATA | 20100805 | |||
2 | Importing | IV_FIELD_EXTERNAL | Call by reference | Type reference (TYPE) | FIELDNAME | 20100805 | |||
3 | Importing | IV_FIELD_INTERNAL | Call by reference | Type reference (TYPE) | FIELDNAME | 20100805 | |||
4 | Importing | IV_OBJECT_SOURCE | Call by reference | Type reference (TYPE) | TABNAME | 20100805 | |||
5 | Importing | IV_OBJECT_TYPE | Call by reference | Type reference (TYPE) | PARAMETER | 20100805 |
Method DO_ASSIGNMENT on class CL_DOC_SEARCH_WRAPPER_BASE has no exception.
Method FREE_DATA Signature
Method FREE_DATA on class CL_DOC_SEARCH_WRAPPER_BASE has no parameter.
Method FREE_DATA on class CL_DOC_SEARCH_WRAPPER_BASE has no exception.
Method GET_DESCR Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | IV_FIELDNAME | Call by reference | Type reference (TYPE) | FIELDNAME | 20100805 | |||
2 | Importing | IV_FIELDVALUE | Call by reference | Type reference (TYPE) | DATA | 20100805 | |||
3 | Returning | RV_DESCR | Value transfer | Type reference (TYPE) | STRING | 20100805 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CX_DOC_SEARCH_WRAPPER | Exception Class for Search Wrapper API | 20100908 |
Method GET_DOCUMENTS Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Exporting | ET_KEY_HEAD | Call by reference | Type reference (TYPE) | SORTED TABLE | Table of Retrieved Document Keys | 20100805 | ||
2 | Exporting | ET_KEY_HEAD_ITEM | Call by reference | Type reference (TYPE) | SORTED TABLE | Table of Retrieved Document Head-Item Keys | 20100907 | ||
3 | Exporting | ET_MESSAGES | Call by reference | Type reference (TYPE) | TDT_SW_MSG | Messages | 20100805 | ||
4 | Exporting | ET_RESULTS_HEAD | Call by reference | Type reference (TYPE) | STANDARD TABLE | Application-Specific Output Table (Header Data) | 20100907 | ||
5 | Exporting | ET_RESULTS_ITEM | Call by reference | Type reference (TYPE) | STANDARD TABLE | Application-Specific Output Table (Item Data) | 20100805 | ||
6 | Exporting | ET_VALUE_DESCR_HEAD | Call by reference | Type reference (TYPE) | TDT_VALUE_DESCR | Table of Retrieved Descriptions | 20100907 | ||
7 | Exporting | EV_MORE_ENTRIES | Call by reference | Type reference (TYPE) | FLAG | Flag: Further Results Available | 20100805 | ||
8 | Importing | IS_SELCRIT | Call by reference | Type reference (TYPE) | DATA | Container for Selection Criteria (e.g. TDS_SW_SELCRIT_* ) | 20100805 | ||
9 | Importing | IT_DILATE_SELECT_FIND_BY | Call by reference | Type reference (TYPE) | TDT_SW_DILATE_SELECT | Additional WHERE Clause Statements for FIND_BY Classes | 20100907 | ||
10 | Importing | IT_DILATE_SELECT_HEAD | Call by reference | Type reference (TYPE) | TDT_SW_SEL_CONDITION | Additional WHERE Clause Statements for Head Selection | 20100907 | ||
11 | Importing | IT_DILATE_SELECT_ITEM | Call by reference | Type reference (TYPE) | TDT_SW_SEL_CONDITION | Additional WHERE Clause Statements for Item Selection | 20100907 | ||
12 | Importing | IT_MAP_FIELDS | Call by reference | Type reference (TYPE) | TDT_SW_MAP_FIELDS | Mapping Table for Output Fields of Document Search | 20100805 | ||
13 | Importing | IT_REQUEST_DESCR_HEAD | Call by reference | Type reference (TYPE) | TDT_FIELDNAME | Table of Requested Descriptions | 20100907 | ||
14 | Importing | IV_KEY_NAME_RES_HEAD | Call by reference | Type reference (TYPE) | FIELDNAME | Field Name of Head Key in Output Table (Header Data) | 20100907 | ||
15 | Importing | IV_KEY_NAME_RES_ITEM | Call by reference | Type reference (TYPE) | FIELDNAME | Field Name of Item Key in Output Table (Item Data) | 20100907 | ||
16 | Importing | IV_KEY_NAME_RES_ITEM_PARENT | Call by reference | Type reference (TYPE) | FIELDNAME | Field Name of Item Parent Key in Output Table (Item Data) | 20100908 | ||
17 | Importing | IV_MAXSEL | Call by reference | Type reference (TYPE) | TBMAXSEL | SPACE | Maximum Number of Documents to be Selected | 20100805 | |
18 | Importing | IV_REQUEST_ITEM | Call by reference | Type reference (TYPE) | FLAG | SPACE | Flag: Output of Item Data is Requested | 20100907 | |
19 | Importing | IV_REQUEST_SEL_ITEM | Call by reference | Type reference (TYPE) | FLAG | SPACE | Flag: Selection on Item Level Required | 20100907 | |
20 | Importing | IV_USECASE_ID | Call by reference | Type reference (TYPE) | TDD_SW_USECASE_ID | Usecase ID based on Domain | 20101221 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CX_DOC_SEARCH_WRAPPER | Exception Class for Search Wrapper API | 20100908 |
Method GET_FIND_BY_INSTANCES Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Exporting | ET_FIND_BY_INSTANCES | Call by reference | Type reference (TYPE) | IF_FIND_DOCS_BY_ELEMENTS=>TCT_FIND_DOCS_BY_INSTANCE | 20100805 | |||
2 | Importing | IV_USECASE_ID | Call by reference | Type reference (TYPE) | TDD_SW_USECASE_ID | Searchwrapper Usecase ID | 20101221 |
Method GET_FIND_BY_INSTANCES on class CL_DOC_SEARCH_WRAPPER_BASE has no exception.
Method GET_HEAD_VALUE_DESCR Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Changing | CT_VALUE_DESCR | Call by reference | Type reference (TYPE) | TDT_VALUE_DESCR | 20100805 | |||
2 | Importing | IT_DESCR_REQUEST | Call by reference | Type reference (TYPE) | TDT_FIELDNAME | 20100805 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CX_DOC_SEARCH_WRAPPER | Exception Class for Search Wrapper API | 20100908 |
Method GET_MAIN Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Exporting | ET_KEY_HEAD | Call by reference | Type reference (TYPE) | SORTED TABLE | Table of Retrieved Document Keys | 20100805 | ||
2 | Exporting | ET_KEY_HEAD_ITEM | Call by reference | Type reference (TYPE) | SORTED TABLE | Table of Retrieved Document Head-Item Keys | 20100908 | ||
3 | Exporting | ET_RESULTS_HEAD | Call by reference | Type reference (TYPE) | STANDARD TABLE | Application-Specific Output Table (Header Data) | 20100908 | ||
4 | Exporting | ET_RESULTS_ITEM | Call by reference | Type reference (TYPE) | STANDARD TABLE | Application-Specific Output Table (Item Data) | 20100805 | ||
5 | Exporting | ET_VALUE_DESCR_HEAD | Call by reference | Type reference (TYPE) | TDT_VALUE_DESCR | Table of Retrieved Descriptions | 20100908 | ||
6 | Importing | IT_MAP_FIELDS | Call by reference | Type reference (TYPE) | TDT_SW_MAP_FIELDS | Mapping Table for Output Fields of Document Search | 20100805 | ||
7 | Importing | IT_REQUEST_DESCR_HEAD | Call by reference | Type reference (TYPE) | TDT_FIELDNAME | Table of Requested Descriptions | 20100908 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CX_DOC_SEARCH_WRAPPER | Exception Class for Search Wrapper API | 20100908 |
Method GET_MAIN_ITEM 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 | 20100805 | ||
2 | Changing | CT_RESULTS_HEAD | Call by reference | Type reference (TYPE) | STANDARD TABLE | Application-Specific Output Table (Header Data) | 20100908 | ||
3 | Exporting | ET_KEY_HEAD_ITEM | Call by reference | Type reference (TYPE) | SORTED TABLE | Table of Retrieved Document Head-Item Keys | 20100908 | ||
4 | Exporting | ET_RESULTS_ITEM | Call by reference | Type reference (TYPE) | STANDARD TABLE | Application-Specific Output Table (Item Data) | 20100805 | ||
5 | Exporting | EV_KEY_DEL_HEAD | Call by reference | Type reference (TYPE) | ANY | Key to be Deleted from Result Table | 20100908 | ||
6 | Importing | IT_MAP_FIELDS | Call by reference | Type reference (TYPE) | TDT_SW_MAP_FIELDS | Mapping Table for Output Fields of Document Search | 20100805 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CX_DOC_SEARCH_WRAPPER | Exception Class for Search Wrapper API | 20100908 |
Method GET_NEXT_RESULT_PACK Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Exporting | ET_KEY_HEAD | Call by reference | Type reference (TYPE) | SORTED TABLE | Table of Retrieved Document Keys | 20100805 | ||
2 | Exporting | ET_KEY_HEAD_ITEM | Call by reference | Type reference (TYPE) | SORTED TABLE | Table of Retrieved Document Head-Item Keys | 20100908 | ||
3 | Exporting | ET_MESSAGES | Call by reference | Type reference (TYPE) | TDT_SW_MSG | Messages | 20100908 | ||
4 | Exporting | ET_RESULTS_HEAD | Call by reference | Type reference (TYPE) | STANDARD TABLE | Application-Specific Output Table (Header Data) | 20100908 | ||
5 | Exporting | ET_RESULTS_ITEM | Call by reference | Type reference (TYPE) | STANDARD TABLE | Application-Specific Output Table (Item Data) | 20100805 | ||
6 | Exporting | ET_VALUE_DESCR_HEAD | Call by reference | Type reference (TYPE) | TDT_VALUE_DESCR | Table of Retrieved Descriptions | 20100908 | ||
7 | Exporting | EV_MORE_ENTRIES | Call by reference | Type reference (TYPE) | FLAG | Flag: Further Results Available | 20100805 | ||
8 | Importing | IT_MAP_FIELDS | Call by reference | Type reference (TYPE) | TDT_SW_MAP_FIELDS | Mapping Table for Output Fields of Document Search | 20100805 | ||
9 | Importing | IT_REQUEST_DESCR_HEAD | Call by reference | Type reference (TYPE) | TDT_FIELDNAME | Table of Requested Descriptions | 20100908 | ||
10 | Importing | IV_MAXSEL | Call by reference | Type reference (TYPE) | TBMAXSEL | Maximum Number of Documents to be Selected | 20100805 | ||
11 | Importing | IV_REQUEST_ITEM | Call by reference | Type reference (TYPE) | FLAG | SPACE | Flag: Output of Item Data is Requested | 20100908 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CX_DOC_SEARCH_WRAPPER | Exception Class for Search Wrapper API | 20100908 |
Method INPUT_VALIDATION Signature
Method INPUT_VALIDATION on class CL_DOC_SEARCH_WRAPPER_BASE has no parameter.
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CX_DOC_SEARCH_WRAPPER | Exception Class for Search Wrapper API | 20100908 |
Method MAP_RESULTS Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Changing | CS_RESULTS | Call by reference | Type reference (TYPE) | DATA | 20100805 | |||
2 | Importing | IT_MAP_FIELDS | Call by reference | Type reference (TYPE) | TDT_SW_MAP_FIELDS | 20100805 | |||
3 | Importing | IV_OBJECT_TYPE | Call by reference | Type reference (TYPE) | PARAMETER | 20100805 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CX_DOC_SEARCH_WRAPPER | Exception Class for Search Wrapper API | 20100908 |
Method MOVE_RESULTS Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Changing | CS_RESULT | Call by reference | Type reference (TYPE) | DATA | 20100810 | |||
2 | Importing | IV_FIELD_EXTERNAL | Call by reference | Type reference (TYPE) | FIELDNAME | 20100810 | |||
3 | Importing | IV_FIELD_INTERNAL | Call by reference | Type reference (TYPE) | FIELDNAME | 20100810 | |||
4 | Importing | IV_OBJECT_SOURCE | Call by reference | Type reference (TYPE) | PARAMETER | 20100810 | |||
5 | Importing | IV_OBJECT_TYPE | Call by reference | Type reference (TYPE) | PARAMETER | 20100810 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CX_DOC_SEARCH_WRAPPER | Exception Class for Search Wrapper API | 20100908 |
Method PERFORM_SYNTAX_CHECK Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | IV_ABAP_CLASS_NAME | Call by reference | Type reference (TYPE) | SEOCLSNAME | ABAP class name | 20100908 | ||
2 | Returning | RV_SYNTAX_IS_OK | Value transfer | Type reference (TYPE) | ABAP_BOOL | Flag: Syntax is ok ( yes / no ) | 20100908 |
Method PERFORM_SYNTAX_CHECK on class CL_DOC_SEARCH_WRAPPER_BASE has no exception.
Method SEARCH_DOCUMENTS Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Exporting | ET_KEY_HEAD | Call by reference | Type reference (TYPE) | SORTED TABLE | Table of Retrieved Document Keys | 20100805 | ||
2 | Exporting | ET_KEY_HEAD_ITEM | Call by reference | Type reference (TYPE) | SORTED TABLE | Table of Retrieved Document Head-Item Keys | 20100908 | ||
3 | Exporting | ET_RESULTS_HEAD | Call by reference | Type reference (TYPE) | STANDARD TABLE | Application-Specific Output Table (Header Data) | 20100908 | ||
4 | Exporting | ET_RESULTS_ITEM | Call by reference | Type reference (TYPE) | STANDARD TABLE | Application-Specific Output Table (Item Data) | 20100805 | ||
5 | Exporting | ET_VALUE_DESCR_HEAD | Call by reference | Type reference (TYPE) | TDT_VALUE_DESCR | Table of Retrieved Descriptions | 20100908 | ||
6 | Exporting | EV_MORE_ENTRIES | Call by reference | Type reference (TYPE) | FLAG | Flag: Further Results Available | 20100805 | ||
7 | Importing | IT_MAP_FIELDS | Call by reference | Type reference (TYPE) | TDT_SW_MAP_FIELDS | Mapping Table for Output Fields of Document Search | 20100805 | ||
8 | Importing | IT_REQUEST_DESCR_HEAD | Call by reference | Type reference (TYPE) | TDT_FIELDNAME | Table of Requested Descriptions | 20100908 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CX_DOC_SEARCH_WRAPPER | Exception Class for Search Wrapper API | 20100917 |
Method SET_KEY_DEFINITION Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | IS_KEY_HEAD | Call by reference | Type reference (TYPE) | TCS_KEY_DEF | Key defintion for head | 20100908 | ||
2 | Importing | IS_KEY_ITEM | Call by reference | Type reference (TYPE) | TCS_KEY_DEF | Key defintion for iterm | 20100908 | ||
3 | Importing | IV_WRAPPER_ID | Call by reference | Type reference (TYPE) | CHAR10 | Identifies implementing search wrapper class | 20100831 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CX_DOC_SEARCH_WRAPPER | Exception Class for Search Wrapper API | 20100908 |
History
Last changed by/on | SAP | 20110908 |
SAP Release Created in | 606 |