SAP ABAP Class CL_DSH_TYPE_AHEAD_PROCESSOR (Dictionary Search Helps: Type-Ahead Processor)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-DWB-DIC-F4 (Application Component) F4 Help
     ⤷ SDSH (Package) ABAP Dictionary internal: Poss.entries (F4)

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_DSH_TYPE_AHEAD_PROCESSOR	Dictionary Search Help: Type-Ahead Processor	20121218

Properties

Class	CL_DSH_TYPE_AHEAD_PROCESSOR
Short Description	Dictionary Search Helps: Type-Ahead Processor
Super Class
Instantiability of a Class	0	Private
Final	☑

General Data

Message Class
Program status
Category	0
Package	SDSH	ABAP Dictionary internal: Poss.entries (F4)
Created	20121218	SAP
Last change	20141121
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_DSH_TYPE_AHEAD_PROCESSOR has no forward declaration.

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_DSH_TYPE_AHEAD_PROCESSOR	☐	☐	Dictionary Search Help: Type-Ahead Processor	20121218

Friends

Class CL_DSH_TYPE_AHEAD_PROCESSOR has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	ADDITIONAL_PARAMETERS	Instance attribute	Private	☐	Type reference (TYPE)	IF_DSH_TYPE_AHEAD_PROCESSOR=>TY_S_ADDITIONAL_PARAMETERS			20130214
2	FORCE_TYPE_AHEAD	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL			20130304
3	SEARCH_HELP_METADATA	Instance attribute	Private	☐	Type reference (TYPE)	SHLP_DESCR_T			20121228
4	SH_INTERFACE_FIELD	Instance attribute	Private	☐	Type reference (TYPE)	DDSHIFACE			20121228
5	TYPE_AHEAD_ACTIVE	Static Attribute	Public	☑	Type reference (TYPE)	ABAP_BOOL			20131122
6	VALUE_HELP_PROCESSOR	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_DSH_VALUE_HELP_PROCESSOR			20130118

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	BUILD_RESULT_TABLE	Instance method	Private	Method		20121228
2	CONSTRUCTOR	Instance method	Private	Constructor		20121218
3	CONVERT_REQUEST_TO_SELOPT	Instance method	Private	Method		20130128
4	CONVERT_RESULT_VALUE	Instance method	Private	Method		20130417
5	CREATE_INSTANCE_FOR_FIELD	Static method	Public	Method		20130128
6	CREATE_INSTANCE_FOR_SHLP	Static method	Public	Method		20130128
7	FORCE_TYPE_AHEAD_FLAGS	Instance method	Private	Method		20130305
8	GET_SEARCH_HELP_METADATA	Instance method	Private	Method		20121218
9	GET_SEARCH_HELP_RESULTS	Instance method	Private	Method		20121219
10	GET_TABLE_DESCRIPTOR	Instance method	Private	Method		20130206
11	MAP_FIELD_VALUES_TO_INTERFACE	Static method	Private	Method		20130917
12	MERGE_LIST_AND_OUTPUT	Instance method	Private	Method		20130307
13	PREPARE_TEXT_SEARCH_METADATA	Instance method	Private	Method		20130204

Events

Class CL_DSH_TYPE_AHEAD_PROCESSOR has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_S_FIELD_INDEX_MAPPING	Private	See coding			20130206	BEGIN OF ty_s_field_index_mapping, field_name TYPE fieldname, original_shlp_index TYPE i, type_ahead_index TYPE i, END OF ty_s_field_index_mapping
2	TY_S_SHLP_REFERENCE	Private	See coding			20130128	BEGIN OF ty_s_shlp_reference, from_ddic TYPE abap_bool, table_name TYPE tabname, field_name TYPE fieldname, END OF ty_s_shlp_reference
3	TY_T_FIELD_INDEX_MAPPING	Private	See coding			20130206	ty_t_field_index_mapping TYPE SORTED TABLE OF ty_s_field_index_mapping WITH UNIQUE KEY primary_key COMPONENTS field_name WITH UNIQUE SORTED KEY result_index COMPONENTS type_ahead_index

Method Signatures

Method BUILD_RESULT_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_TYPE_AHEAD_VALUES	Call by reference	☐	Type reference (TYPE)	ANY TABLE			20121228
2	Importing	I_OUTPUT_DESCRIPTION	Call by reference	☐	Type reference (TYPE)	DDFIELDS			20130111
3	Importing	I_RAW_RESULTS	Call by reference	☐	Type reference (TYPE)	DDSHRESLTS			20121228

#	Exception	Resumable	Description	Created on
1	CX_DSH_TYPE_AHEAD_ERROR	☐		20130326

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_ADDITIONAL_PARAMETERS	Call by reference	☐	Type reference (TYPE)	IF_DSH_TYPE_AHEAD_PROCESSOR=>TY_S_ADDITIONAL_PARAMETERS			20130214
2	Importing	I_MASTER_SEARCH_HELP	Call by reference	☐	Type reference (TYPE)	SHLP_DESCR_T			20130128
3	Importing	I_SEARCH_HELP_REFERENCE	Call by reference	☐	Type reference (TYPE)	TY_S_SHLP_REFERENCE			20130128

#	Exception	Resumable	Description	Created on
1	CX_DSH_TYPE_AHEAD_ERROR	☐		20130325

Method CONVERT_REQUEST_TO_SELOPT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_TYPE_AHEAD_REQUEST	Call by reference	☐	Type reference (TYPE)	IF_DSH_TYPE_AHEAD_PROCESSOR=>TY_TYPE_AHEAD_REQUEST			20130128

Method CONVERT_REQUEST_TO_SELOPT on class CL_DSH_TYPE_AHEAD_PROCESSOR has no exception.

Method CONVERT_RESULT_VALUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_CONVERTED_VALUE	Call by reference	☐	Type reference (TYPE)	ANY			20130417
2	Importing	I_FIELD_INFORMATION	Call by reference	☐	Type reference (TYPE)	DFIES			20130417
3	Importing	I_RAW_LINE	Call by reference	☐	Type reference (TYPE)	SEAHLPRES			20130417

#	Exception	Resumable	Description	Created on
1	CX_DSH_TYPE_AHEAD_ERROR	☐		20130417

Method CREATE_INSTANCE_FOR_FIELD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_ADDITIONAL_PARAMETERS	Call by reference	☑	Type reference (TYPE)	IF_DSH_TYPE_AHEAD_PROCESSOR=>TY_S_ADDITIONAL_PARAMETERS			20130214
2	Importing	I_DICTIONARY_FIELD_NAME	Call by reference	☐	Type reference (TYPE)	FIELDNAME			20130128
3	Importing	I_DICTIONARY_TABLE_NAME	Call by reference	☐	Type reference (TYPE)	TABNAME			20130128
4	Returning	R_DSH_TYPE_AHEAD_PROCESSOR	Value transfer	☐	Object reference (TYPE REF TO)	IF_DSH_TYPE_AHEAD_PROCESSOR			20130128

#	Exception	Resumable	Description	Created on
1	CX_DSH_TYPE_AHEAD_ERROR	☐		20130325

Method CREATE_INSTANCE_FOR_SHLP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_ADDITIONAL_PARAMETERS	Call by reference	☑	Type reference (TYPE)	IF_DSH_TYPE_AHEAD_PROCESSOR=>TY_S_ADDITIONAL_PARAMETERS			20130214
2	Importing	I_DATA_ELEMENT_FOR_FIXED_VALUE	Call by reference	☑	Type reference (TYPE)	ROLLNAME			20131113
3	Importing	I_REFERENCED_FIELD_NAME	Call by reference	☐	Type reference (TYPE)	FIELDNAME			20130128
4	Importing	I_SEARCH_HELP_NAME	Call by reference	☐	Type reference (TYPE)	SHLPNAME			20130128
5	Importing	I_SEARCH_HELP_TYPE	Call by reference	☑	Type reference (TYPE)	DDSHLPTYP			20130917
6	Returning	R_DSH_TYPE_AHEAD_PROCESSOR	Value transfer	☐	Object reference (TYPE REF TO)	IF_DSH_TYPE_AHEAD_PROCESSOR			20130128

#	Exception	Resumable	Description	Created on
1	CX_DSH_TYPE_AHEAD_ERROR	☐		20130325

Method FORCE_TYPE_AHEAD_FLAGS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_AVAILABLE_SEARCH_HELPS	Call by reference	☐	Type reference (TYPE)	SHLP_DESCR_TAB_T			20130305
2	Changing	C_MASTER_SEARCH_HELP	Call by reference	☐	Type reference (TYPE)	SHLP_DESCR_T			20130305

Method FORCE_TYPE_AHEAD_FLAGS on class CL_DSH_TYPE_AHEAD_PROCESSOR has no exception.

Method GET_SEARCH_HELP_METADATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_MASTER_SEARCH_HELP	Call by reference	☐	Type reference (TYPE)	SHLP_DESCR_T			20130128
2	Importing	I_SEARCH_HELP_REFERENCE	Call by reference	☐	Type reference (TYPE)	TY_S_SHLP_REFERENCE			20130128

#	Exception	Resumable	Description	Created on
1	CX_DSH_TYPE_AHEAD_ERROR	☐		20130325

Method GET_SEARCH_HELP_RESULTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_SEARCH_HELP_RESULTS	Call by reference	☐	Type reference (TYPE)	ANY TABLE			20121219
2	Importing	I_MAX_RESULTS	Call by reference	☐	Type reference (TYPE)	I			20130206

#	Exception	Resumable	Description	Created on
1	CX_DSH_TYPE_AHEAD_DISABLED	☐		20130306
2	CX_DSH_TYPE_AHEAD_ERROR	☐		20130326

Method GET_TABLE_DESCRIPTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_FIELD_INDEX_MAPPING	Call by reference	☐	Type reference (TYPE)	TY_T_FIELD_INDEX_MAPPING			20130206
2	Exporting	E_TABLE_DESCRIPTOR	Call by reference	☐	Object reference (TYPE REF TO)	CL_ABAP_TABLEDESCR			20130206
3	Importing	I_DDIC_DESCRIPTOR	Call by reference	☐	Type reference (TYPE)	DDFIELDS			20130206

Method GET_TABLE_DESCRIPTOR on class CL_DSH_TYPE_AHEAD_PROCESSOR has no exception.

Method MAP_FIELD_VALUES_TO_INTERFACE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_SEARCH_HELP_METADATA	Call by reference	☐	Type reference (TYPE)	SHLP_DESCR_T			20130917
2	Importing	I_ADDITIONAL_PARAMETERS	Call by reference	☐	Type reference (TYPE)	IF_DSH_TYPE_AHEAD_PROCESSOR=>TY_S_ADDITIONAL_PARAMETERS			20130917

Method MAP_FIELD_VALUES_TO_INTERFACE on class CL_DSH_TYPE_AHEAD_PROCESSOR has no exception.

Method MERGE_LIST_AND_OUTPUT Signature

Method MERGE_LIST_AND_OUTPUT on class CL_DSH_TYPE_AHEAD_PROCESSOR has no parameter.
Method MERGE_LIST_AND_OUTPUT on class CL_DSH_TYPE_AHEAD_PROCESSOR has no exception.

Method PREPARE_TEXT_SEARCH_METADATA Signature

Method PREPARE_TEXT_SEARCH_METADATA on class CL_DSH_TYPE_AHEAD_PROCESSOR has no parameter.
Method PREPARE_TEXT_SEARCH_METADATA on class CL_DSH_TYPE_AHEAD_PROCESSOR has no exception.

History

Last changed by/on	SAP	20141121
SAP Release Created in	740