SAP ABAP Class CL_GFS_WB (Workbench Class for Entry Screen)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SRV-FSI (Application Component) Fast Search Infrastructure
     ⤷ SFSG_WB2 (Package) Fast Search Workbench Tool

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_WB_PROGRAM	Workbench: Program	20040511
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_WB_PROGRAM_STATE	Workbench Manager: State of a Tool or Browser	20040511

Properties

Class	CL_GFS_WB
Short Description	Workbench Class for Entry Screen
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	SFSG_WB2	Fast Search Workbench Tool
Created	20040511	SAP
Last change	20050308	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_GFS_WB has no forward declaration.

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_WB_PROGRAM	☐	☐	Workbench: Program	20040511
2	IF_WB_PROGRAM_STATE	☐	☐	Workbench Manager: State of a Tool or Browser	20040511

Friends

Class CL_GFS_WB has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	ACTIVE_REQUEST	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_WB_REQUEST		Current Request	20040722
2	MR_CL_WB_REQUEST	Instance attribute	Public	☐	Object reference (TYPE REF TO)	CL_WB_REQUEST		Workbench Manager: Request	20040603
3	MR_DEF	Instance attribute	Public	☐	Object reference (TYPE REF TO)	IF_GFS_DEFINITION		GFS Definition	20040527
4	MR_EXT	Instance attribute	Public	☐	Object reference (TYPE REF TO)	IF_GFS_EXTENSION			20040527
5	MR_INSTANCE	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CL_GFS_WB		Workbench Class for Entry Screen	20040603
6	MR_REPOSITORY	Instance attribute	Public	☐	Object reference (TYPE REF TO)	IF_GFS_REPOSITORY		Repository Impl.	20040527
7	MR_SEARCHDEF	Instance attribute	Public	☐	Object reference (TYPE REF TO)	IF_GFS_SEARCHDEF		GFS Search Definition	20040527
8	MR_VIEWDEF	Instance attribute	Public	☐	Object reference (TYPE REF TO)	IF_GFS_VIEWDEF			20040527
9	MS_LASTSAVEPARS	Instance attribute	Public	☐	Type reference (TYPE)	SFSG_DEFINITION		Definition Structure	20040604
10	MX_AUTHORITY_ERROR	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CX_GFS_AUTHORITY_ERROR		Fast Search Basis Exception Class	20050224
11	MX_DUP_ENTRY	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CX_SFS_DUPLICATE_ENTRY		Fast Search Exception - Duplicate Entry	20040527
12	MX_EDITSTATUS_ERROR	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CX_GFS_EDITSTATUS_ERROR		Fast Search Basis Exception Class	20040527
13	MX_INVALID_ID	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CX_SFS_INVALID_ID		Fast Search Exception - Invalid ID	20040527
14	MX_LOCK_ERROR	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CX_SFS_LOCK_ERROR		Fast Search Enqueue Error	20040527
15	MX_NOT_FOUND	Instance attribute	Public	☐	Object reference (TYPE REF TO)	CX_SFS_NOT_FOUND		Entry Not Found	20040527
16	MX_ORIGIN_NOT_FOUND	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CX_GFS_ORIGIN_NOT_FOUND		Extension Origin not Found	20040527
17	MX_TR_ERROR	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CX_GFS_TR_ERROR		Transport Error	20040527
18	MX_WRITE_ERROR	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CX_SFS_WRITE_ERROR		Error while exporting data	20040527
19	M_DEF_NAME	Instance attribute	Public	☐	Type reference (TYPE)	STRING			20040527
20	M_DEF_NAME_FORM	Instance attribute	Public	☐	Type reference (TYPE)	SFSG_DEFINITION_NAME		Search Definition Name of Generic Fast Search	20040527
21	M_LASTSAVEPARS	Instance attribute	Public	☐	Type reference (TYPE)	SFSG_DEFINITION		Definition Structure	20040511
22	M_MODE	Instance attribute	Private	☐	Type reference (TYPE)	MODE_T			20040527
23	M_PARENT	Instance attribute	Private	☐	Type reference (TYPE)	STRING		Name of the parent in case of extension	20040527
24	M_PARENT_FORM	Instance attribute	Private	☐	Type reference (TYPE)	SFSG_DEFINITION_NAME		Search Definition Name of Generic Fast Search	20040527
25	M_TYPE	Instance attribute	Private	☐	Type reference (TYPE)	SEU_OBJTYP		Type of Object for Processing	20040603
26	M_WASSAVED	Instance attribute	Public	☐	Type reference (TYPE)	C			20040629

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ACTIVE_SEARCHDEF_EXISTS	Instance method	Public	Method		20040511
2	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20040511
3	GATHER_INFO	Instance method	Public	Method	Get the information for the search definition	20040511
4	GET_INSTANCE	Static method	Public	Method		20040603
5	GET_MODE	Instance method	Public	Method	Get the current mode the workbench is in (View, Searchdef, E	20040527
6	GET_SEARCHDEF	Instance method	Public	Method		20040514
7	HANDLE_DOMAIN_SEARCHDEF	Instance method	Public	Method		20040604
8	HANDLE_DOMAIN_VIEW	Instance method	Public	Method		20040604
9	IS_SET_SEARCHDEF	Instance method	Public	Method	Checks if a search def. has been set	20040603
10	LOCK	Instance method	Public	Method		20040511
11	ONACTIVATE	Instance method	Public	Method		20040511
12	ONCHECK	Instance method	Public	Method		20040511
13	ONCOPY	Instance method	Public	Method	Copy a search definition or object	20040621
14	ONCREATE	Instance method	Public	Method		20040511
15	ONDELETE	Instance method	Public	Method	Deletion of a Definition	20040511
16	ONDELETEWITHOUTSAVE	Instance method	Public	Method		20040629
17	ONDISPLAY	Instance method	Public	Method	Check and get information on a search definition for display	20040511
18	ONF4	Instance method	Public	Method		20040511
19	ONSAVE	Instance method	Public	Method		20040511
20	SEARCHDEF_EXISTS	Instance method	Public	Method	Check if Search Definition Already Exists	20040511
21	SET_MODE	Instance method	Public	Method	Set the current mode ('V' , 'S' , or 'E')	20040527
22	SET_NAME	Instance method	Public	Method	Set the name of the object the workbench is working on	20040527
23	SET_SEARCHDEF	Instance method	Public	Method		20040514
24	SH_ON_DOUBLE_CLICK	Instance method	Public	Event handling method	Handler for double click in search help	20040511
25	UNLOCK	Instance method	Public	Method		20040511
26	WASCHANGED	Instance method	Public	Method		20040511

Events

Class CL_GFS_WB has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	MODE_T	Public	See coding		Mode type: 'V' View; 'S' SearchDef; 'E' Extension	20040527	MODE_T(1) type C
2	TAB_STRING	Public	See coding			20040511	TAB_STRING type table of string

Method Signatures

Method ACTIVE_SEARCHDEF_EXISTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_EXISTS	Call by reference	☐	Type reference (TYPE)	C			20040511
2	Importing	I_DEF_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20040511

Method ACTIVE_SEARCHDEF_EXISTS on class CL_GFS_WB has no exception.

Method CONSTRUCTOR Signature

Method CONSTRUCTOR on class CL_GFS_WB has no parameter.
Method CONSTRUCTOR on class CL_GFS_WB has no exception.

Method GATHER_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_INFO	Call by reference	☐	Type reference (TYPE)	SFSG_DEFINITION		Definition Struktur	20040511
2	Importing	I_SEARCHREF	Call by reference	☐	Object reference (TYPE REF TO)	IF_GFS_SEARCHDEF		GFS Search Definition	20040511

Method GATHER_INFO on class CL_GFS_WB has no exception.

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	RR_INSTANCE	Call by reference	☐	Object reference (TYPE REF TO)	CL_GFS_WB		Workbench Class for Entry Screen	20040603

Method GET_INSTANCE on class CL_GFS_WB has no exception.

Method GET_MODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	E_MODE	Value transfer	☐	Type reference (TYPE)	MODE_T		Mode type: 'V' View; 'S' SearchDef; 'E' Extension	20040527

Method GET_MODE on class CL_GFS_WB has no exception.

Method GET_SEARCHDEF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_SEARCHDEF	Call by reference	☐	Object reference (TYPE REF TO)	IF_GFS_SEARCHDEF		GFS Search Definition	20040514

Method GET_SEARCHDEF on class CL_GFS_WB has no exception.

Method HANDLE_DOMAIN_SEARCHDEF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	P_WB_REQUEST	Call by reference	☐	Object reference (TYPE REF TO)	CL_WB_REQUEST		Workbench Manager: Request	20040604

Method HANDLE_DOMAIN_SEARCHDEF on class CL_GFS_WB has no exception.

Method HANDLE_DOMAIN_VIEW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	P_WB_REQUEST	Call by reference	☐	Object reference (TYPE REF TO)	CL_WB_REQUEST		Workbench Manager: Request	20040604

Method HANDLE_DOMAIN_VIEW on class CL_GFS_WB has no exception.

Method IS_SET_SEARCHDEF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_ISSET	Value transfer	☐	Type reference (TYPE)	C			20040603

Method IS_SET_SEARCHDEF on class CL_GFS_WB has no exception.

Method LOCK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_MSG	Call by reference	☐	Type reference (TYPE)	STRING			20040511
2	Importing	I_SEARCH_DEF	Call by reference	☑	Object reference (TYPE REF TO)	IF_GFS_SEARCHDEF		GFS Search Definition	20040514

Method LOCK on class CL_GFS_WB has no exception.

Method ONACTIVATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ER_MSG	Call by reference	☐	Object reference (TYPE REF TO)	IF_GFS_PROTOCOL		Fast Search Fehlerliste	20040609
2	Exporting	E_MSG	Call by reference	☐	Type reference (TYPE)	STRING			20040511

Method ONACTIVATE on class CL_GFS_WB has no exception.

Method ONCHECK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ER_MSG	Call by reference	☐	Object reference (TYPE REF TO)	IF_GFS_PROTOCOL		Fast Search Fehlerliste	20040609
2	Importing	I_SEARCHDEFPARS	Call by reference	☐	Type reference (TYPE)	SFSG_DEFINITION		Definition Struktur	20041018

Method ONCHECK on class CL_GFS_WB has no exception.

Method ONCOPY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_MSG	Call by reference	☐	Type reference (TYPE)	STRING			20040621
2	Importing	I_DEF_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20040621
3	Importing	I_MODE	Call by reference	☐	Type reference (TYPE)	C			20040621
4	Importing	I_NEWNAME	Call by reference	☐	Type reference (TYPE)	STRING			20040621

Method ONCOPY on class CL_GFS_WB has no exception.

Method ONCREATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_EXTDEF	Call by reference	☐	Object reference (TYPE REF TO)	IF_GFS_EXTENSION			20040527
2	Exporting	E_MSG	Call by reference	☐	Type reference (TYPE)	STRING			20040511
3	Exporting	E_SEARCHDEF	Call by reference	☐	Object reference (TYPE REF TO)	IF_GFS_SEARCHDEF		GFS Search Definition	20040514
4	Exporting	E_VIEWDEF	Call by reference	☐	Object reference (TYPE REF TO)	IF_GFS_VIEWDEF		GFS View Definition	20040527
5	Importing	I_DEF_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20040511
6	Importing	I_MODE	Call by reference	☐	Type reference (TYPE)	MODE_T		Mode type: 'V' View; 'S' SearchDef; 'E' Extension	20040527
7	Importing	I_PARENT	Call by reference	☑	Type reference (TYPE)	STRING			20040527

Method ONCREATE on class CL_GFS_WB has no exception.

Method ONDELETE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_MSG	Call by reference	☐	Type reference (TYPE)	STRING			20040511
2	Importing	I_DEF_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20040511
3	Importing	I_MODE	Call by reference	☐	Type reference (TYPE)	MODE_T		Mode type: 'V' View; 'S' SearchDef; 'E' Extension	20040601

Method ONDELETE on class CL_GFS_WB has no exception.

Method ONDELETEWITHOUTSAVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_MSG	Call by reference	☐	Type reference (TYPE)	STRING			20040629

Method ONDELETEWITHOUTSAVE on class CL_GFS_WB has no exception.

Method ONDISPLAY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_MSG	Call by reference	☐	Type reference (TYPE)	STRING			20040511
2	Exporting	E_SEARCHDEF	Call by reference	☐	Object reference (TYPE REF TO)	IF_GFS_SEARCHDEF		Definition Struktur	20040511
3	Exporting	E_VIEWDEF	Call by reference	☐	Object reference (TYPE REF TO)	IF_GFS_VIEWDEF		GFS View Definition	20040528
4	Importing	I_DEF_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20040511
5	Importing	I_FOREDIT	Call by reference	☐	Type reference (TYPE)	C			20040511
6	Importing	I_MODE	Call by reference	☐	Type reference (TYPE)	MODE_T		Mode type: 'V' View; 'S' SearchDef; 'E' Extension	20040527

Method ONDISPLAY on class CL_GFS_WB has no exception.

Method ONF4 Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_NAMES	Value transfer	☐	Type reference (TYPE)	TAB_STRING			20040511
2	Importing	I_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20040511
3	Importing	I_TYPE	Call by reference	☐	Type reference (TYPE)	C			20040511

Method ONF4 on class CL_GFS_WB has no exception.

Method ONSAVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_MSG	Call by reference	☐	Type reference (TYPE)	STRING			20040511
2	Importing	I_SEARCHDEFPARS	Call by reference	☐	Type reference (TYPE)	SFSG_DEFINITION		Definition Struktur	20040511

Method ONSAVE on class CL_GFS_WB has no exception.

Method SEARCHDEF_EXISTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_EXISTS	Call by reference	☐	Type reference (TYPE)	C			20040511
2	Importing	I_DEF_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20040511

Method SEARCHDEF_EXISTS on class CL_GFS_WB has no exception.

Method SET_MODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_MODE	Call by reference	☐	Type reference (TYPE)	MODE_T		Mode type: 'V' View; 'S' SearchDef; 'E' Extension	20040527

Method SET_MODE on class CL_GFS_WB has no exception.

Method SET_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_DEF_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20040527

Method SET_NAME on class CL_GFS_WB has no exception.

Method SET_SEARCHDEF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_SEARCHDEF	Call by reference	☐	Object reference (TYPE REF TO)	IF_GFS_SEARCHDEF		GFS Search Definition	20040514

Method SET_SEARCHDEF on class CL_GFS_WB has no exception.

Method SH_ON_DOUBLE_CLICK Signature

Method SH_ON_DOUBLE_CLICK on class CL_GFS_WB has no parameter.
Method SH_ON_DOUBLE_CLICK on class CL_GFS_WB has no exception.

Method UNLOCK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_MSG	Call by reference	☐	Type reference (TYPE)	STRING			20040511

Method UNLOCK on class CL_GFS_WB has no exception.

Method WASCHANGED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_ACTIVE	Call by reference	☐	Type reference (TYPE)	C			20040511
2	Exporting	E_CHANGED	Value transfer	☐	Type reference (TYPE)	C			20040511
3	Importing	I_DEFINITION	Call by reference	☐	Type reference (TYPE)	SFSG_DEFINITION		Definition Struktur	20040511

Method WASCHANGED on class CL_GFS_WB has no exception.

History

Last changed by/on	SAP	20050308
SAP Release Created in	700