SAP ABAP Class CL_BUS_LOCATOR_SEARCH_MANAGER (Locator: Read Access to Customizing and DDIC)

Hierarchy

☛ SAP_ABA (Software Component) Cross-Application Component
   ⤷ AP-MD-BP-UI (Application Component) Dialog SAP-GUI
     ⤷ BUS_TOOLS (Package) Locator

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_BUS_LOCATOR_SEARCH_FRIEND	Locator: FRIEND Interface for Local Classes	20001219

Properties

Class	CL_BUS_LOCATOR_SEARCH_MANAGER
Short Description	Locator: Read Access to Customizing and DDIC
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class	BUS_LOCATOR
Program status
Category	0
Package	BUS_TOOLS	Locator
Created	20001219	SAP
Last change	20001219	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☐
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	SHLP	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_BUS_LOCATOR_SEARCH_FRIEND	☐	☐	Locator: FRIEND Interface for Local Classes	20001219

Friends

Class CL_BUS_LOCATOR_SEARCH_MANAGER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_DYNPRO_NUMBER	Constant	Private	☐	See coding			Constant: Screen Numbers in Main Function Group	20001219
2	GC_PROGRAM_NAME	Constant	Private	☐	Type reference (TYPE)	BUS_SCREEN-PROGRAM_NAME	'SAPLBUS_LOCATOR'	Constant: Program Name of Main Function Group	20001219
3	GC_SHLP_STATE	Constant	Private	☐	Type reference (TYPE)	DDREFSTRUC-STATE	'A'	Constant: DDIC, Active Condition	20001219
4	GC_X	Constant	Protected	☐	Type reference (TYPE)	BUS_LOCATOR-BOOLEAN	'X'	Constant: TRUE	20001219
5	GT_CI2T	Static Attribute	Private	☐	See coding			Buffer: Assign IDs to Categories	20001219
6	GT_CT2A	Static Attribute	Private	☐	See coding			Buffer: Assign Categories to Applications	20001219
7	GT_SEARCH_APPLICATION_INIT	Static Attribute	Private	☐	See coding			Initialized Search Applications	20001219

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_CONSISTENCY	Static method	Public	Method	Checks Consistency of Customizing	20001219
2	GET_APP_FUNCTION	Static method	Public	Method	Provides Standard Modules of a Search Application	20001219
3	GET_APP_OF_ID	Static method	Public	Method	Provides Search Application of a Search ID	20001219
4	GET_APP_OF_TYPE	Static method	Public	Method	Provides Search Application of a Search Category	20001219
5	GET_DEFAULT_ID_FOR_TYPE	Static method	Public	Method	Provides Standard Search ID of a Search Category	20001219
6	GET_DEFAULT_TYPE_FOR_APP	Static method	Public	Method	Provides Standard Search Category of a Search Application	20001219
7	GET_IDS_FOR_TYPE	Static method	Public	Method	Provides the Search ID of a Search Category	20001219
8	GET_ID_FUNCTION	Static method	Public	Method	Provides the Search Module of a Search ID	20001219
9	GET_ID_PROGRAM_AND_DYNPRO	Static method	Public	Method	Provides the Search Program/Screen of a Search ID	20001219
10	GET_ID_SUB_SCREEN	Static method	Public	Method	Provides the Search Subscreen of a Search ID	20001219
11	GET_ID_TEXT	Static method	Public	Method	Provides the Text of a Search ID	20001219
12	GET_INCLUDED_SEARCH_HELPS	Static method	Private	Method	Provides Included Search Helps of a Collective Search Help	20001219
13	GET_INCLUDED_SEARCH_HELPS_MULT	Static method	Private	Method	Delivers Included Search Helps for Several Collective SHs	20030417
14	GET_TYPES_FOR_APP	Static method	Public	Method	Provides the Search Categories of a Search Application	20001219
15	GET_TYPE_OF_ID	Static method	Public	Method	Provides the Search Category of a Search ID	20001219
16	GET_TYPE_TEXT	Static method	Public	Method	Provides the Text of a Search Category	20001219
17	INITIALIZE_SEARCH_APPLICATION	Static method	Private	Method	Initializes a Search Application	20001219
18	INITIALIZE_SEARCH_APPLICATIONS	Static method	Public	Method	Initializes the Buffer for a Number of Search Applications	20001219
19	INITIALIZE_SEARCH_APPLIC_MULT	Static method	Private	Method	Initializes Several Search Applications (Performance)	20030417
20	TRY_TO_GET_SEARCH_SCREEN	Static method	Public	Method	Supplies reference to a search screen, if possible	20010618

Events

Class CL_BUS_LOCATOR_SEARCH_MANAGER has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TTY_CI2T	Private	See coding			20030417
2	TTY_CT2A	Private	See coding			20030417
3	TY_CI2T	Private	See coding		Cannot Import Type	20001219
4	TY_CT2A	Private	See coding		Cannot Import Type	20001219
5	TY_SEARCH_HELP	Private	Type reference (TYPE)	DD30L-SHLPNAME	TY_SEARCH_HELP	20001219
6	TY_SEARCH_HELP_TABLE	Private	See coding		Cannot Import Type	20001219

Method Signatures

Method CHECK_CONSISTENCY Signature

Method CHECK_CONSISTENCY on class CL_BUS_LOCATOR_SEARCH_MANAGER has no parameter.
Method CHECK_CONSISTENCY on class CL_BUS_LOCATOR_SEARCH_MANAGER has no exception.

Method GET_APP_FUNCTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_FUNCTION	Call by reference	☐	Type reference (TYPE)	BUS_LOCATOR-SEARCH_FUNCTION		EV_FUNCTION	20001219
2	Importing	IV_SEARCH_APPLICATION	Call by reference	☐	Type reference (TYPE)	BUS_LOCATOR-SEARCH_APPLICATION		IV_SEARCH_APPLICATION	20001219

#	Exception	Resumable	Description	Created on
1	FUNCTION_NOT_DEFINED	☐	FUNCTION_NOT_DEFINED	20001219

Method GET_APP_OF_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_SEARCH_APPLICATION	Call by reference	☐	Type reference (TYPE)	BUS_LOCATOR-SEARCH_APPLICATION		EV_SEARCH_APPLICATION	20001219
2	Importing	IV_SEARCH_ID	Call by reference	☐	Type reference (TYPE)	BUS_LOCATOR-SEARCH_ID		IV_SEARCH_ID	20001219

Method GET_APP_OF_ID on class CL_BUS_LOCATOR_SEARCH_MANAGER has no exception.

Method GET_APP_OF_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_SEARCH_APPLICATION	Call by reference	☐	Type reference (TYPE)	BUS_LOCATOR-SEARCH_APPLICATION		EV_SEARCH_APPLICATION	20001219
2	Importing	IV_SEARCH_TYPE	Call by reference	☐	Type reference (TYPE)	BUS_LOCATOR-SEARCH_TYPE		IV_SEARCH_TYPE	20001219

Method GET_APP_OF_TYPE on class CL_BUS_LOCATOR_SEARCH_MANAGER has no exception.

Method GET_DEFAULT_ID_FOR_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_SEARCH_ID	Call by reference	☐	Type reference (TYPE)	BUS_LOCATOR-SEARCH_ID		EV_SEARCH_ID	20001219
2	Importing	IV_SEARCH_TYPE	Call by reference	☐	Type reference (TYPE)	BUS_LOCATOR-SEARCH_TYPE		IV_SEARCH_TYPE	20001219

Method GET_DEFAULT_ID_FOR_TYPE on class CL_BUS_LOCATOR_SEARCH_MANAGER has no exception.

Method GET_DEFAULT_TYPE_FOR_APP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_SEARCH_TYPE	Call by reference	☐	Type reference (TYPE)	BUS_LOCATOR-SEARCH_TYPE		EV_SEARCH_TYPE	20001219
2	Importing	IV_SEARCH_APPLICATION	Call by reference	☐	Type reference (TYPE)	BUS_LOCATOR-SEARCH_APPLICATION		IV_SEARCH_APPLICATION	20001219

Method GET_DEFAULT_TYPE_FOR_APP on class CL_BUS_LOCATOR_SEARCH_MANAGER has no exception.

Method GET_IDS_FOR_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_SEARCH_IDS	Call by reference	☐	Type reference (TYPE)	BUS_LOCATOR-SEARCH_ID_TABLE		ET_SEARCH_IDS	20001219
2	Importing	IV_SEARCH_TYPE	Call by reference	☐	Type reference (TYPE)	BUS_LOCATOR-SEARCH_TYPE		IV_SEARCH_TYPE	20001219

Method GET_IDS_FOR_TYPE on class CL_BUS_LOCATOR_SEARCH_MANAGER has no exception.

Method GET_ID_FUNCTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_FUNCTION	Call by reference	☐	Type reference (TYPE)	BUS_LOCATOR-SEARCH_FUNCTION		EV_FUNCTION	20001219
2	Importing	IV_SEARCH_ID	Call by reference	☐	Type reference (TYPE)	BUS_LOCATOR-SEARCH_ID		IV_SEARCH_ID	20001219

#	Exception	Resumable	Description	Created on
1	FUNCTION_NOT_DEFINED	☐	FUNCTION_NOT_DEFINED	20001219

Method GET_ID_PROGRAM_AND_DYNPRO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_BIG_DYNPRO	Call by reference	☐	Type reference (TYPE)	BUS_SCREEN-DYNPRO_NUMBER		Nummer des großen Dynpros	20010618
2	Exporting	EV_DYNPRO_NUMBER	Call by reference	☐	Type reference (TYPE)	BUS_SCREEN-DYNPRO_NUMBER		EV_DYNPRO_NUMBER	20001219
3	Exporting	EV_PROGRAM_NAME	Call by reference	☐	Type reference (TYPE)	BUS_SCREEN-PROGRAM_NAME		EV_PROGRAM_NAME	20001219
4	Importing	IV_SEARCH_ID	Call by reference	☐	Type reference (TYPE)	BUS_LOCATOR-SEARCH_ID		IV_SEARCH_ID	20001219

#	Exception	Resumable	Description	Created on
1	PROGRAM_OR_DYNPRO_NOT_DEFINED	☐	PROGRAM_OR_DYNPRO_NOT_DEFINED	20001219

Method GET_ID_SUB_SCREEN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_SCREEN	Call by reference	☐	Object reference (TYPE REF TO)	CL_BUS_ABSTRACT_SUB_SCREEN		EV_SCREEN	20010618
2	Importing	IV_AVAILABLE_WIDTH	Call by reference	☑	Type reference (TYPE)	I		Zur Verfügung stehende Dynprobreite	20010618
3	Importing	IV_SEARCH_ID	Call by reference	☐	Type reference (TYPE)	BUS_LOCATOR-SEARCH_ID		IV_SEARCH_ID	20001219

Method GET_ID_SUB_SCREEN on class CL_BUS_LOCATOR_SEARCH_MANAGER has no exception.

Method GET_ID_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_TEXT	Call by reference	☐	Type reference (TYPE)	C		EV_TEXT	20001219
2	Importing	IV_LANGUAGE	Call by reference	☐	Type reference (TYPE)	SY-LANGU		IV_LANGUAGE	20001219
3	Importing	IV_SEARCH_ID	Call by reference	☐	Type reference (TYPE)	BUS_LOCATOR-SEARCH_ID		IV_SEARCH_ID	20001219

Method GET_ID_TEXT on class CL_BUS_LOCATOR_SEARCH_MANAGER has no exception.

Method GET_INCLUDED_SEARCH_HELPS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_SEARCH_HELPS	Call by reference	☐	Type reference (TYPE)	TY_SEARCH_HELP_TABLE		ET_SEARCH_HELPS	20001219
2	Importing	IV_RETURN_ONLY_COLLECTIVE	Call by reference	☑	Type reference (TYPE)	BU_BOOLEAN		IV_RETURN_ONLY_COLLECTIVE	20001219
3	Importing	IV_RETURN_ONLY_ELEMENTARY	Call by reference	☑	Type reference (TYPE)	BU_BOOLEAN		IV_RETURN_ONLY_ELEMENTARY	20001219
4	Importing	IV_SEARCH_HELP	Call by reference	☐	Type reference (TYPE)	TY_SEARCH_HELP		IV_SEARCH_HELP	20001219

#	Exception	Resumable	Description	Created on
1	CANNOT_READ_SEARCH_HELP	☐	CANNOT_READ_SEARCH_HELP	20001219
2	MORE_THAN_ONE_RESTRICTION	☐	MORE_THAN_ONE_RESTRICTION	20001219

Method GET_INCLUDED_SEARCH_HELPS_MULT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_CI2T	Call by reference	☐	Type reference (TYPE)	TTY_CI2T		TTY_CI2T	20030417
2	Exporting	ET_CT2A	Call by reference	☐	Type reference (TYPE)	TTY_CT2A		TTY_CT2A	20030417
3	Importing	IT_SEARCH_HELPS	Call by reference	☐	Type reference (TYPE)	TY_SEARCH_HELP_TABLE		IT_SEARCH_HELPS	20030417
4	Importing	IV_RETURN_ONLY_COLLECTIVE	Call by reference	☑	Type reference (TYPE)	BU_BOOLEAN		IV_RETURN_ONLY_COLLECTIVE	20030417
5	Importing	IV_RETURN_ONLY_ELEMENTARY	Call by reference	☑	Type reference (TYPE)	BU_BOOLEAN		IV_RETURN_ONLY_ELEMENTARY	20030417

#	Exception	Resumable	Description	Created on
1	CANNOT_READ_SEARCH_HELP	☐	CANNOT_READ_SEARCH_HELP	20030417
2	MORE_THAN_ONE_RESTRICTION	☐	MORE_THAN_ONE_RESTRICTION	20030417

Method GET_TYPES_FOR_APP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_SEARCH_TYPES	Call by reference	☐	Type reference (TYPE)	BUS_LOCATOR-SEARCH_TYPE_TABLE		ET_SEARCH_TYPES	20001219
2	Importing	IV_SEARCH_APPLICATION	Call by reference	☐	Type reference (TYPE)	BUS_LOCATOR-SEARCH_APPLICATION		IV_SEARCH_APPLICATION	20001219

Method GET_TYPES_FOR_APP on class CL_BUS_LOCATOR_SEARCH_MANAGER has no exception.

Method GET_TYPE_OF_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_SEARCH_TYPE	Call by reference	☐	Type reference (TYPE)	BUS_LOCATOR-SEARCH_TYPE		EV_SEARCH_TYPE	20001219
2	Importing	IV_SEARCH_ID	Call by reference	☐	Type reference (TYPE)	BUS_LOCATOR-SEARCH_ID		IV_SEARCH_ID	20001219

Method GET_TYPE_OF_ID on class CL_BUS_LOCATOR_SEARCH_MANAGER has no exception.

Method GET_TYPE_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_TEXT_PLURAL	Call by reference	☐	Type reference (TYPE)	C		EV_TEXT_PLURAL	20001219
2	Exporting	EV_TEXT_SINGULAR	Call by reference	☐	Type reference (TYPE)	C		EV_TEXT_SINGULAR	20001219
3	Importing	IV_LANGUAGE	Call by reference	☐	Type reference (TYPE)	SY-LANGU		IV_LANGUAGE	20001219
4	Importing	IV_SEARCH_TYPE	Call by reference	☐	Type reference (TYPE)	BUS_LOCATOR-SEARCH_TYPE		IV_SEARCH_TYPE	20001219

Method GET_TYPE_TEXT on class CL_BUS_LOCATOR_SEARCH_MANAGER has no exception.

Method INITIALIZE_SEARCH_APPLICATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_SEARCH_APPLICATION	Call by reference	☐	Type reference (TYPE)	BUS_LOCATOR-SEARCH_APPLICATION		IV_SEARCH_APPLICATION	20001219

#	Exception	Resumable	Description	Created on
1	CANNOT_READ_SEARCH_HELP	☐	CANNOT_READ_SEARCH_HELP	20001219
2	NO_COLLECTIVE_SEARCH_HELP	☐	NO_COLLECTIVE_SEARCH_HELP	20001219
3	NO_ELEMENTARY_SEARCH_HELP	☐	NO_ELEMENTARY_SEARCH_HELP	20001219

Method INITIALIZE_SEARCH_APPLICATIONS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_SEARCH_APPLICATIONS	Call by reference	☐	Type reference (TYPE)	BUS_LOCATOR-SEARCH_APPLICATION_TABLE		IT_SEARCH_APPLICATIONS	20001219

Method INITIALIZE_SEARCH_APPLICATIONS on class CL_BUS_LOCATOR_SEARCH_MANAGER has no exception.

Method INITIALIZE_SEARCH_APPLIC_MULT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_SEARCH_APPLICATIONS	Call by reference	☐	Type reference (TYPE)	BUS_LOCATOR-SEARCH_APPLICATION_TABLE		IT_SEARCH_APPLICATIONS	20030417

Method INITIALIZE_SEARCH_APPLIC_MULT on class CL_BUS_LOCATOR_SEARCH_MANAGER has no exception.

Method TRY_TO_GET_SEARCH_SCREEN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_SEARCH_SCREEN	Call by reference	☐	Object reference (TYPE REF TO)	CL_BUS_LOCATOR_SEARCH_SCREEN		Such-Subscreen für Locator-Such-IDs	20010618
2	Importing	IV_SCREEN	Call by reference	☐	Object reference (TYPE REF TO)	CL_BUS_ABSTRACT_SUB_SCREEN		Locator: Wrapper für einen Subscreen	20010618

Method TRY_TO_GET_SEARCH_SCREEN on class CL_BUS_LOCATOR_SEARCH_MANAGER has no exception.

History

Last changed by/on	SAP	20001219
SAP Release Created in	50A