SAP ABAP Class CL_BUS_LOCATOR_SEARCH (Locator: Search)

Hierarchy

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

Properties

Class	CL_BUS_LOCATOR_SEARCH
Short Description	Locator: Search
Super Class
Instantiability of a Class	0	Private
Final	☑

General Data

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

Forward declarations

Class CL_BUS_LOCATOR_SEARCH has no forward declaration.

Interfaces

Class CL_BUS_LOCATOR_SEARCH has no interface implemented.

Friends

#	Friend	Modeled only	Created on	Description
1	IF_BUS_LOCATOR_SEARCH_FRIEND	☐	20001108	Locator: FRIEND Interface for Local Classes

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_X	Constant	Protected	☐	Type reference (TYPE)	BUS_LOCATOR-BOOLEAN	'X'	Constant for True	20000120
2	GS_MESSAGE	Instance attribute	Private	☐	Type reference (TYPE)	SYMSG		Transient: Structure of Message Variables of a Search Run	20000228
3	GT_SEARCH_RESULT	Instance attribute	Public	☐	Type reference (TYPE)	BUS_LOCATOR-SEARCH_RESULT		Transient: List Object Key Found, Describable	20000120
4	GV_CREATION_TIMESTAMP	Instance attribute	Private	☐	Type reference (TYPE)	TIMESTAMP		Persistent: Generation Time for Friend lcl_search_history	20000426
5	GV_CURSOR_FIELD	Instance attribute	Private	☐	Type reference (TYPE)	BUS_SCREEN-FIELD_NAME		Transient: Cursor Field	20001121
6	GV_CURSOR_LINE	Instance attribute	Private	☐	Type reference (TYPE)	I		Transient: Cursor Line	20001121
7	GV_CURSOR_SCREEN	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_BUS_ABSTRACT_SCREEN		Transient: Cursor Screen	20001121
8	GV_MAXIMUM_ROWS	Instance attribute	Public	☑	Type reference (TYPE)	I		Transient: Maximum Number for Selected Lines	20000426
9	GV_SEARCH_APPLICATION	Instance attribute	Public	☑	Type reference (TYPE)	BUS_LOCATOR-SEARCH_APPLICATION		Persistent: Search Application	20000228
10	GV_SEARCH_FIELDS	Instance attribute	Public	☑	Type reference (TYPE)	BUS_LOCATOR-SEARCH_FIELDS		Persistent: Search Field Values	20000120
11	GV_SEARCH_ID	Instance attribute	Public	☑	Type reference (TYPE)	BUS_LOCATOR-SEARCH_ID		Persistent: Search ID	20000120
12	GV_SEARCH_TYPE	Instance attribute	Public	☑	Type reference (TYPE)	BUS_LOCATOR-SEARCH_TYPE		Persistent: Search Type	20000120
13	GV_TRANSIENT_OBJECT	Instance attribute	Public	☐	Object reference (TYPE REF TO)	OBJECT		Transient: Additional Data for the Application, Describable	20000124
14	GV_WAS_PERFORMED	Instance attribute	Public	☑	Type reference (TYPE)	BUS_LOCATOR-BOOLEAN		Transient: Search is Executed	20000426

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CLEAR_MESSAGE	Instance method	Public	Method	Deletes the Collected Messages	20000426
2	COLLECT_MESSAGE	Instance method	Public	Method	Collects a Message from the SY-MSG* Fields	20000426
3	CREATE	Static method	Public	Method	Creates a New Instance	20000120
4	GET_RANGE_FOR	Static method	Public	Method	Generates a Range Table	20000120
5	IS_EQUAL_TO	Instance method	Private	Method	Checks Search for Match of Search Category/ID/Fields	20000120
6	OUTPUT_MESSAGE	Instance method	Public	Method	Delivers the Collected Messages as an Exception	20000426
7	SET_MAXIMUM_ROWS	Instance method	Private	Method	Sets the Maximum Number for Selected Lines	20000426
8	SET_WAS_PERFORMED	Instance method	Private	Method	Selects the Search as Executed	20000426

Events

Class CL_BUS_LOCATOR_SEARCH has no event.

Types

Class CL_BUS_LOCATOR_SEARCH has no local type.

Method Signatures

Method CLEAR_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CURSOR_FIELD	Call by reference	☑	Type reference (TYPE)	BUS_SCREEN-FIELD_NAME		Cursorfeld	20001121
2	Importing	IV_CURSOR_LINE	Call by reference	☑	Type reference (TYPE)	I		Cursorzeile	20001121

Method CLEAR_MESSAGE on class CL_BUS_LOCATOR_SEARCH has no exception.

Method COLLECT_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CURSOR_FIELD	Call by reference	☑	Type reference (TYPE)	BUS_SCREEN-FIELD_NAME		Cursorfeld	20000426
2	Importing	IV_CURSOR_LINE	Call by reference	☑	Type reference (TYPE)	I		Cursorzeile	20001121

Method COLLECT_MESSAGE on class CL_BUS_LOCATOR_SEARCH has no exception.

Method CREATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_SEARCH	Call by reference	☐	Object reference (TYPE REF TO)	CL_BUS_LOCATOR_SEARCH		Instanz	20000120
2	Importing	IV_CREATION_TIMESTAMP	Call by reference	☑	Type reference (TYPE)	TIMESTAMP		Private: Erzeugungszeitpunkt beim Laden von der Datenbank	20000509
3	Importing	IV_SEARCH_APPLICATION	Call by reference	☐	Type reference (TYPE)	BUS_LOCATOR-SEARCH_APPLICATION		Such Anwendung	20000228
4	Importing	IV_SEARCH_FIELDS	Call by reference	☐	Type reference (TYPE)	BUS_LOCATOR-SEARCH_FIELDS		Werte der Suchfelder	20000120
5	Importing	IV_SEARCH_ID	Call by reference	☐	Type reference (TYPE)	BUS_LOCATOR-SEARCH_ID		Such Id	20000120
6	Importing	IV_SEARCH_TYPE	Call by reference	☐	Type reference (TYPE)	BUS_LOCATOR-SEARCH_TYPE		Such Typ	20000120

Method CREATE on class CL_BUS_LOCATOR_SEARCH has no exception.

Method GET_RANGE_FOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_RANGE	Call by reference	☐	Type reference (TYPE)	STANDARD TABLE		Ranges Tabelle	20000120
2	Importing	IV_VALUE	Call by reference	☐	Type reference (TYPE)	ANY		Wert, evtl. mit '*'	20000120

Method GET_RANGE_FOR on class CL_BUS_LOCATOR_SEARCH has no exception.

Method IS_EQUAL_TO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_OTHER_SEARCH	Call by reference	☐	Object reference (TYPE REF TO)	CL_BUS_LOCATOR_SEARCH		Vergleichssuche	20000120
2	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	BUS_LOCATOR-BOOLEAN		'X' falls Gleichheit vorliegt	20000120

Method IS_EQUAL_TO on class CL_BUS_LOCATOR_SEARCH has no exception.

Method OUTPUT_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_CURSOR_FIELD	Call by reference	☐	Type reference (TYPE)	BUS_SCREEN-FIELD_NAME		Cursorfeld	20001121
2	Exporting	EV_CURSOR_LINE	Call by reference	☐	Type reference (TYPE)	I		Cursorzeile	20001121
3	Exporting	EV_CURSOR_SCREEN	Call by reference	☐	Object reference (TYPE REF TO)	CL_BUS_ABSTRACT_SCREEN		Cursorscreen	20001121

#	Exception	Resumable	Description	Created on
1	MESSAGE_OCCURRED	☐	Es ist irgendeine Meldung aufgetreten	20000426

Method SET_MAXIMUM_ROWS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_MAXIMUM_ROWS	Call by reference	☐	Type reference (TYPE)	I		Maximale Anzahl zu selektierender Zeilen	20000426

Method SET_MAXIMUM_ROWS on class CL_BUS_LOCATOR_SEARCH has no exception.

Method SET_WAS_PERFORMED Signature

Method SET_WAS_PERFORMED on class CL_BUS_LOCATOR_SEARCH has no parameter.
Method SET_WAS_PERFORMED on class CL_BUS_LOCATOR_SEARCH has no exception.

History

Last changed by/on	SAP	20130531
SAP Release Created in	12A