SAP ABAP Class CL_CFX_SEARCH_CRITERIA (CFX Search: Search Criteria)

Hierarchy

☛ CPRXRPM (Software Component) SAP Portfolio and Project Management 6.0
   ⤷ PLM-CFO (Application Component) Collaboration Folders
     ⤷ CFX_SEARCH (Package) CFX: Search in cFolders

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_CFX_SEARCH_CRITERIA	CFX: Interface for Search Condition	20010827

Properties

Class	CL_CFX_SEARCH_CRITERIA
Short Description	CFX Search: Search Criteria
Super Class
Instantiability of a Class	0	Private
Final	☑

General Data

Message Class
Program status
Category	0
Package	CFX_SEARCH	CFX: Search in cFolders
Created	20010824	SAP
Last change	20141109
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	CL_CFX_SEARCH_APPLICATION	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
3	IF_CFX_SEARCH_CRITERIA	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_CFX_SEARCH_CRITERIA	☐	☐	CFX: Interface for Search Condition	20010827

Friends

#	Friend	Modeled only	Created on	Description
1	CL_CFX_SEARCH_APPLICATION	☐	20010824	CFX Search: Application Singleton

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MP_TSEARCH_CACHE	Instance attribute	Public	☐	Object reference (TYPE REF TO)	CL_CFX_TSEARCH_CACHE		CFX TREX Search	20060829
2	MT_ALL_MATCHWORDS	Instance attribute	Public	☐	Type reference (TYPE)	CFX_TT_ALL_SEARCHMATCH		CFX Index Search: Metadata List of Objects	20040324
3	MT_MATCHREASONS	Instance attribute	Private	☐	Type reference (TYPE)	CFX_TT_MATCHEDWORDS		CFX Search: List of Matched Contexts	20010927
4	MT_MATCHWORDS	Instance attribute	Private	☐	Type reference (TYPE)	CFX_TT_SEARCHMATCH		Table with Match Words	20010827
5	MT_SEARCH_OBJ_TYPES	Instance attribute	Private	☐	Type reference (TYPE)	TYPE_INT_OBJ_TYPES		List with Object Types	20020319
6	MT_USERS	Instance attribute	Private	☐	Type reference (TYPE)	TYPE_USERLIST		(Tuning)	20010906
7	MT_VISITEDOBJECTS	Instance attribute	Private	☐	Type reference (TYPE)	TYPE_VISITEDFOLDERS			20020405
8	MT_WORDS	Instance attribute	Private	☐	Type reference (TYPE)	CFX_TT_STRING		Table of Strings	20010824
9	M_ADDITIONAL_CONTEXT	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20020417
10	M_DATA_FOR_SEARCH	Instance attribute	Private	☐	Type reference (TYPE)	I	0	One of the SC_DATA_* Constants	20011002
11	M_MODE	Instance attribute	Private	☐	Type reference (TYPE)	CFX_T_SEARCHMODE		Search Mode (And, Or)	20010824
12	M_OBJDESC	Instance attribute	Private	☐	Type reference (TYPE)	CFX_STRING		Character String for Collaboration Folders	20010910
13	M_OBJNAME	Instance attribute	Private	☐	Type reference (TYPE)	CFX_STRING		Character String for Collaboration Folders	20010910
14	M_OBJTYPE_CATEGORY	Instance attribute	Private	☐	Type reference (TYPE)	I	0	One of the SC_OBJTYPE_* Constants	20020319
15	M_READY	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL			20010906
16	M_RESULT	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL			20010906
17	M_SEARCH_OBJ_DESCRIPTION	Instance attribute	Private	☐	Type reference (TYPE)	CFX_ID		Description ID (Type+Category)	20040206
18	M_STRCONTEXTLEN	Constant	Private	☐	Type reference (TYPE)	I	30	String Length at the "Find" Point	20011002
19	SC_ATTRIBUTE_SEARCH	Constant	Public	☐	Type reference (TYPE)	CHAR2	CL_CFX_SEARCH_UI=>SC_ATTRIBUTE_SEARCH		20060913
20	SC_TAG_ANDORMODE	Constant	Private	☐	Type reference (TYPE)	TEXT10	'AndOrMode'	'And' or 'Or'	20010824
21	SC_TAG_DATAFORSEARCH	Constant	Private	☐	Type reference (TYPE)	TEXT10	'Data'	Text (10 Characters)	20011002
22	SC_TAG_SEARCHENV	Constant	Private	☐	Type reference (TYPE)	TEXT10	'Criteria'	'Criteria'	20010824
23	SC_TAG_SEARCHOBJTYPE	Constant	Private	☐	Type reference (TYPE)	TEXT20	'SearchObjType'	Text (20 Characters)	20020404
24	SC_TAG_SEARCHOBJTYPE_CATEGORY	Constant	Private	☐	Type reference (TYPE)	TEXT20	'SearchObjTypeCat'	Text (20 Characters)	20020319
25	SC_TAG_SEARCHWORD	Constant	Private	☐	Type reference (TYPE)	TEXT20	'SearchWord'	Text (20 Characters)	20010824
26	SC_TAG_SEARCHWORDS	Constant	Private	☐	Type reference (TYPE)	TEXT20	'SearchWords'	Text (20 Characters)	20010824

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_VISITED_OBJECT	Instance method	Private	Method	Notes the Referenced Folder	20020405
2	CLEAR_MATCHWORDS	Instance method	Public	Method		20061121
3	CREATE_FROM_WORDS	Static method	Public	Method	Generate Complex Search Criteria with Multiple Words	20010905
4	CREATE_FROM_XML	Static method	Private	Method	Generate Search Criteria from XML	20010824
5	GET_ALL_OBJ_TYPES	Static method	Private	Method	Delivers List with All Searchable Object Categories	20020319
6	GET_BP_SEARCH_CRITERIA	Instance method	Public	Method	Fetches the BP search criteria from the class attributes	20060211
7	GET_STRINGCONTEXT	Instance method	Private	Method	Delivers Environment for a Found Substring	20010927
8	GET_XML	Instance method	Private	Method	Convert Search Criteria by XML	20010824
9	IS_OBJECT_DESCRIPTION_WANTED	Instance method	Private	Method	Checks Whether Specified Object Type/Category Is to Be Found	20040206
10	IS_OBJECT_VISITED	Instance method	Private	Method	Delivers True, If the Referenced Folder Was Already Visited	20020405
11	IS_READY_ANDMODE	Instance method	Private	Method	Search Condition Fulfilled for AND Link	20010827
12	IS_READY_ORMODE	Instance method	Private	Method	Search Condition Fulfilled for OR Link	20010827
13	MATCHES	Instance method	Private	Method	String Comparison Operation	20010827
14	OBJ_TYPE_IN_LIST	Instance method	Private	Method	Checks Whether Specified Object Category Should Be Searched	20020319
15	RESET_MATCH	Instance method	Public	Method	Empty List with Match Words for New Search	20010827
16	SET_ADDITIONAL_SEARCH_CONTEXT	Instance method	Public	Method	Set Optional Search Context	20020417
17	SET_OBJTYPES_FOR_CATEGORY	Instance method	Private	Method	Delivers Object Categories for Specified Category	20020319
18	WANTS_INDEXSERVER	Instance method	Public	Method	Delivers True if Also Have to Search for Documents	20031010

Events

Class CL_CFX_SEARCH_CRITERIA has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TYPE_INT_OBJ_TYPES	Private	See coding			20030320
2	TYPE_USER	Private	See coding			20010910
3	TYPE_USERLIST	Private	See coding			20010910
4	TYPE_VISITEDFOLDERS	Private	See coding			20010918

Method Signatures

Method ADD_VISITED_OBJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_ID	Call by reference	☐	Type reference (TYPE)	GUID_32		GUID im 'CHAR' Format in Großschreibung	20020405

Method ADD_VISITED_OBJECT on class CL_CFX_SEARCH_CRITERIA has no exception.

Method CLEAR_MATCHWORDS Signature

Method CLEAR_MATCHWORDS on class CL_CFX_SEARCH_CRITERIA has no parameter.
Method CLEAR_MATCHWORDS on class CL_CFX_SEARCH_CRITERIA has no exception.

Method CREATE_FROM_WORDS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IP_OBJECT_DESCRIPTION	Call by reference	☑	Object reference (TYPE REF TO)	CL_CFX_OBJECT_DESCRIPTION		Wenn nicht inital, nur Ergebnisse mit diesem type & typing	20040206
2	Importing	IT_OBJECT_TYPES	Call by reference	☑	Type reference (TYPE)	CFX_TT_OBJECT_TYPE		wenn CATEGORY = EXPLICIT, dann diese Typen suchen	20020404
3	Importing	IT_WORDS	Call by reference	☐	Type reference (TYPE)	CFX_TT_STRING		Tabelle mit strings	20010905
4	Importing	I_DATAFORSEARCH	Call by reference	☐	Type reference (TYPE)	I	0		20011002
5	Importing	I_MODE	Call by reference	☐	Type reference (TYPE)	TEXT10	IF_CFX_SEARCH_CRITERIA=>SC_MODE_OR	constant sc_mode*	20010905
6	Importing	I_OBJECTTYPE_CATEGORY	Call by reference	☐	Type reference (TYPE)	I	IF_CFX_SEARCH_CRITERIA=>SC_OBJTYPE_ALL	0 .. sc_objtype_max	20020319
7	Returning	RP_CRITERIA	Value transfer	☐	Object reference (TYPE REF TO)	CL_CFX_SEARCH_CRITERIA		CFX Suchen: Suchkriterium	20010905

Method CREATE_FROM_WORDS on class CL_CFX_SEARCH_CRITERIA has no exception.

Method CREATE_FROM_XML Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_XML	Call by reference	☐	Type reference (TYPE)	CFX_XSTRING		xstring	20010824
2	Returning	RP_CRITERIA	Value transfer	☐	Object reference (TYPE REF TO)	CL_CFX_SEARCH_CRITERIA		CFX Suchen: Suchkriterium	20010824

Method CREATE_FROM_XML on class CL_CFX_SEARCH_CRITERIA has no exception.

Method GET_ALL_OBJ_TYPES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RT_OBJ_TYPES	Value transfer	☐	Type reference (TYPE)	CFX_TT_CLASSIC_OBJECT_TYPE		Liste mit Objekttypen	20020319

Method GET_ALL_OBJ_TYPES on class CL_CFX_SEARCH_CRITERIA has no exception.

Method GET_BP_SEARCH_CRITERIA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_BP_CRITERIA	Call by reference	☐	Type reference (TYPE)	CFX_TT_STRING		Table of Strings	20060211

Method GET_BP_SEARCH_CRITERIA on class CL_CFX_SEARCH_CRITERIA has no exception.

Method GET_STRINGCONTEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CRITERIAWORD	Call by reference	☐	Type reference (TYPE)	STRING			20010927
2	Importing	I_INDEX	Call by reference	☐	Type reference (TYPE)	I			20010927
3	Importing	I_MATCHWORD	Call by reference	☐	Type reference (TYPE)	STRING			20010927
4	Returning	R_CONTEXT	Value transfer	☐	Type reference (TYPE)	STRING			20010927

Method GET_STRINGCONTEXT on class CL_CFX_SEARCH_CRITERIA has no exception.

Method GET_XML Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_XML	Value transfer	☐	Type reference (TYPE)	CFX_XSTRING		xstring	20010824

Method GET_XML on class CL_CFX_SEARCH_CRITERIA has no exception.

Method IS_OBJECT_DESCRIPTION_WANTED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IP_OBJECT_DESCRIPTION	Call by reference	☐	Object reference (TYPE REF TO)	CL_CFX_OBJECT_DESCRIPTION		Objekttyp+Katekorie	20040206
2	Returning	R_SEARCH	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20040206

Method IS_OBJECT_DESCRIPTION_WANTED on class CL_CFX_SEARCH_CRITERIA has no exception.

Method IS_OBJECT_VISITED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_FOL_ID	Call by reference	☐	Type reference (TYPE)	GUID_32		GUID im 'CHAR' Format in Großschreibung	20020405
2	Returning	R_VISITED	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20020405

Method IS_OBJECT_VISITED on class CL_CFX_SEARCH_CRITERIA has no exception.

Method IS_READY_ANDMODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_MATCHREASONS	Call by reference	☐	Type reference (TYPE)	CFX_TT_MATCHEDWORDS		CFX Suchen: Gematchtes Word mit KontextId und String-Kontext	20010927
2	Exporting	E_READY	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20010827
3	Exporting	E_RESULT	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20010827

Method IS_READY_ANDMODE on class CL_CFX_SEARCH_CRITERIA has no exception.

Method IS_READY_ORMODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_MATCHREASONS	Call by reference	☐	Type reference (TYPE)	CFX_TT_MATCHEDWORDS		CFX Suchen: Liste gematchter Kontexte	20010927
2	Exporting	E_READY	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20010827
3	Exporting	E_RESULT	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20010827

Method IS_READY_ORMODE on class CL_CFX_SEARCH_CRITERIA has no exception.

Method MATCHES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_CONTEXT	Call by reference	☐	Type reference (TYPE)	STRING			20010927
2	Exporting	E_MATCH	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20010927
3	Importing	I_CRITERIAWORD	Call by reference	☐	Type reference (TYPE)	STRING			20010827
4	Importing	I_MATCHWORD	Call by reference	☐	Type reference (TYPE)	STRING			20010827

Method MATCHES on class CL_CFX_SEARCH_CRITERIA has no exception.

Method OBJ_TYPE_IN_LIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IP_OBJECT_TYPE	Call by reference	☐	Object reference (TYPE REF TO)	CL_CFX_OBJECT_TYPE		Objekttyp	20040206
2	Returning	R_SEARCH	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20020319

Method OBJ_TYPE_IN_LIST on class CL_CFX_SEARCH_CRITERIA has no exception.

Method RESET_MATCH Signature

Method RESET_MATCH on class CL_CFX_SEARCH_CRITERIA has no parameter.
Method RESET_MATCH on class CL_CFX_SEARCH_CRITERIA has no exception.

Method SET_ADDITIONAL_SEARCH_CONTEXT Signature

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

Method SET_ADDITIONAL_SEARCH_CONTEXT on class CL_CFX_SEARCH_CRITERIA has no exception.

Method SET_OBJTYPES_FOR_CATEGORY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IP_OBJECT_DESCRIPTION	Call by reference	☑	Object reference (TYPE REF TO)	CL_CFX_OBJECT_DESCRIPTION		Objektbeschreibung ( Typ + Typisierung )	20040206
2	Importing	IT_OBJECT_TYPES	Call by reference	☐	Type reference (TYPE)	CFX_TT_OBJECT_TYPE		Liste mit Objekttypen	20020404
3	Importing	I_OBJTYPE_CATEGORY	Call by reference	☐	Type reference (TYPE)	I		Konstante zw. 0 .. SC_OBJTYPE_MAX	20020319

Method SET_OBJTYPES_FOR_CATEGORY on class CL_CFX_SEARCH_CRITERIA has no exception.

Method WANTS_INDEXSERVER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_WANTED	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20031010

Method WANTS_INDEXSERVER on class CL_CFX_SEARCH_CRITERIA has no exception.

History

Last changed by/on	SAP	20141109
SAP Release Created in	100