SAP ABAP Class CL_CFX_P_SEARCH (CFX Search: Persistence Singleton)

Hierarchy

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

Properties

Class	CL_CFX_P_SEARCH
Short Description	CFX Search: Persistence Singleton
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	20010820	SAP
Last change	20141109
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_CFX_P_SEARCH has no forward declaration.

Interfaces

Class CL_CFX_P_SEARCH has no interface implemented.

Friends

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

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	SC_CHECKEDOUT_DOCS	Constant	Private	☐	Type reference (TYPE)	CFX_C1	'D'	'D'=Documents	20020528
2	SC_FAVORITES	Constant	Private	☐	Type reference (TYPE)	CFX_C1	'F'	'F' = Favorites	20020528
3	SP_INSTANCE	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CL_CFX_P_SEARCH		CFX Search: Persistence Singleton	20010820

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CREATE	Instance method	Private	Method	Writes Search Queries to the Database	20010820
2	DELETE	Instance method	Private	Method	Deletes Search Queries and Possible Results from Database	20010821
3	DELETE_SEARCH_PROGRESS	Instance method	Private	Method	Deletes Synchronization to Database	20010926
4	GET_CHECKEDOUT_DOCS_LIST	Instance method	Private	Method	Reads Document List (XML) from Database for User	20020528
5	GET_CRITERIA_XSTR	Instance method	Private	Method	Reads XML String for the Criteria Object	20011002
6	GET_FAVORITE_LIST	Instance method	Private	Method	Reads Favorites List (XML) from Database for User	20020104
7	GET_HIT_COUNT	Instance method	Private	Method	Reads Amount of Hits	20010917
8	GET_INSTANCE	Static method	Private	Method	Delivers the Only Instance	20010820
9	GET_SEARCHES	Instance method	Private	Method	Reads Search Queries from Database, Without Criteria	20010820
10	GET_SEARCH_DETAIL	Instance method	Private	Method	Reads Details of a Search Query	20011002
11	GET_SEARCH_IDS	Instance method	Private	Method	Reads Search IDs from the Database	20010820
12	GET_SEARCH_PROGRESS	Instance method	Private	Method	Reads Progress of Search Operation	20010926
13	GET_SEARCH_RESULT	Instance method	Private	Method	Reads Results	20010827
14	SET_CHECKEDOUT_DOCS_LIST	Instance method	Private	Method	Writes/Updates Document List (XML) to Database	20020528
15	SET_FAVORITE_LIST	Instance method	Private	Method	Writes/Updates Favorites List (XML) to Database	20020104
16	SET_SEARCH_AS_FINISHED	Instance method	Private	Method	Marks Search as Ended and Stores Result in Database	20010822
17	START_SEARCH_SYNC	Instance method	Private	Method	Synchronizes Search Operation Using Table	20010926
18	UPDATE_RESULTS	Instance method	Private	Method	Update of Results to Database	20010919
19	UPDATE_SEARCH_SYNC	Instance method	Private	Method	Writes Progress of Search Operation	20010926

Events

Class CL_CFX_P_SEARCH has no event.

Types

Class CL_CFX_P_SEARCH has no local type.

Method Signatures

Method CREATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CRITERIA	Call by reference	☐	Type reference (TYPE)	CFX_XSTRING		xstring	20010820
2	Importing	I_DESCRIPTION	Call by reference	☐	Type reference (TYPE)	STRING			20010820
3	Importing	I_FINISHDATE	Call by reference	☐	Type reference (TYPE)	TZNTSTMPS		UTC-Zeitstempel in Kurzform (JJJJMMTThhmmss)	20010820
4	Importing	I_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20010820
5	Importing	I_SEARCH_ID	Call by reference	☐	Type reference (TYPE)	GUID_32		GUID im 'CHAR' Format in Großschreibung	20010820
6	Importing	I_SOURCE	Call by reference	☐	Type reference (TYPE)	CHAR2	SPACE		20060411
7	Importing	I_STATUS	Call by reference	☐	Type reference (TYPE)	CFX_C1		'P' = progress, 'F' = finished	20010820
8	Importing	I_USER	Call by reference	☐	Type reference (TYPE)	CFX_USER_ID		Anmeldename des Benutzers	20010820

Method CREATE on class CL_CFX_P_SEARCH has no exception.

Method DELETE Signature

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

Method DELETE on class CL_CFX_P_SEARCH has no exception.

Method DELETE_SEARCH_PROGRESS Signature

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

Method DELETE_SEARCH_PROGRESS on class CL_CFX_P_SEARCH has no exception.

Method GET_CHECKEDOUT_DOCS_LIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_USER	Call by reference	☐	Type reference (TYPE)	CFX_USERID		User Id	20020528
2	Returning	R_DOCUMENTS_AS_XML	Value transfer	☐	Type reference (TYPE)	CFX_XSTRING		xstring	20020528

Method GET_CHECKEDOUT_DOCS_LIST on class CL_CFX_P_SEARCH has no exception.

Method GET_CRITERIA_XSTR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_XML	Call by reference	☐	Type reference (TYPE)	CFX_XSTRING		xstring	20011002
2	Importing	I_SEARCHID	Call by reference	☐	Type reference (TYPE)	GUID_32		GUID im 'CHAR' Format in Großschreibung	20011002

Method GET_CRITERIA_XSTR on class CL_CFX_P_SEARCH has no exception.

Method GET_FAVORITE_LIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_USER	Call by reference	☐	Type reference (TYPE)	CFX_USERID		User Id	20020104
2	Returning	R_FAVORITES_AS_XML	Value transfer	☐	Type reference (TYPE)	CFX_XSTRING		xstring	20020104

Method GET_FAVORITE_LIST on class CL_CFX_P_SEARCH has no exception.

Method GET_HIT_COUNT Signature

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

Method GET_HIT_COUNT on class CL_CFX_P_SEARCH has no exception.

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RP_P_INSTANCE	Value transfer	☐	Object reference (TYPE REF TO)	CL_CFX_P_SEARCH		CFX Suchen: Persistenz-Singleton	20010820

Method GET_INSTANCE on class CL_CFX_P_SEARCH has no exception.

Method GET_SEARCHES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_SEARCHES	Call by reference	☐	Type reference (TYPE)	CFX_TT_SEARCH		CFX: interne Tabelle mit Suchanfragen	20010820
2	Importing	I_SOURCE	Call by reference	☐	Type reference (TYPE)	CHAR2	SPACE		20060411
3	Importing	I_USER	Call by reference	☐	Type reference (TYPE)	SYUNAME		Anmeldename des Benutzers	20010820

Method GET_SEARCHES on class CL_CFX_P_SEARCH has no exception.

Method GET_SEARCH_DETAIL Signature

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

Method GET_SEARCH_DETAIL on class CL_CFX_P_SEARCH has no exception.

Method GET_SEARCH_IDS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_IDS	Call by reference	☐	Type reference (TYPE)	CFX_TT_GUID_32		Tabelle mit guids	20010820
2	Importing	I_SOURCE	Call by reference	☑	Type reference (TYPE)	CHAR2			20060413
3	Importing	I_USER	Call by reference	☐	Type reference (TYPE)	SYUNAME		Anmeldename des Benutzers	20010820

Method GET_SEARCH_IDS on class CL_CFX_P_SEARCH has no exception.

Method GET_SEARCH_PROGRESS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_PROGRESS	Call by reference	☐	Type reference (TYPE)	I		0 <= progress <= total	20010926
2	Exporting	E_TOTAL	Call by reference	☐	Type reference (TYPE)	I			20010926
3	Importing	I_SEARCHID	Call by reference	☐	Type reference (TYPE)	GUID_32		GUID im 'CHAR' Format in Großschreibung	20010926

Method GET_SEARCH_PROGRESS on class CL_CFX_P_SEARCH has no exception.

Method GET_SEARCH_RESULT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_SEARCHRES	Value transfer	☐	Type reference (TYPE)	CFX_SEARCHRES		CFX: Liste der Suchergebnisse	20010827
2	Importing	I_SEARCHID	Call by reference	☐	Type reference (TYPE)	GUID_32		GUID im 'CHAR' Format in Großschreibung	20010827

Method GET_SEARCH_RESULT on class CL_CFX_P_SEARCH has no exception.

Method SET_CHECKEDOUT_DOCS_LIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_DOCUMENTS_AS_XML	Call by reference	☐	Type reference (TYPE)	CFX_XSTRING		xstring	20020528
2	Importing	I_ELEMENT_COUNT	Call by reference	☐	Type reference (TYPE)	I			20020528
3	Importing	I_USER	Call by reference	☐	Type reference (TYPE)	CFX_USERID		User Id	20020528

Method SET_CHECKEDOUT_DOCS_LIST on class CL_CFX_P_SEARCH has no exception.

Method SET_FAVORITE_LIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_ELEMENT_COUNT	Call by reference	☐	Type reference (TYPE)	I		Anzahl Objekte in Favoriten	20020528
2	Importing	I_FAVORITES_AS_XML	Call by reference	☐	Type reference (TYPE)	CFX_XSTRING		xstring	20020104
3	Importing	I_USER	Call by reference	☐	Type reference (TYPE)	CFX_USERID		User Id	20020104

Method SET_FAVORITE_LIST on class CL_CFX_P_SEARCH has no exception.

Method SET_SEARCH_AS_FINISHED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_COUNT	Call by reference	☐	Type reference (TYPE)	I		Anzahl Ergebnisse	20010917
2	Importing	I_FINISHDATE	Call by reference	☐	Type reference (TYPE)	TZNTSTMPS		UTC-Zeitstempel in Kurzform (JJJJMMTThhmmss)	20010828
3	Importing	I_SEARCHID	Call by reference	☐	Type reference (TYPE)	GUID_32		GUID im 'CHAR' Format in Großschreibung	20010822
4	Importing	I_SEARCH_RESULTS	Call by reference	☐	Type reference (TYPE)	CFX_XSTRING		xstring	20010822
5	Importing	I_STATUS	Call by reference	☐	Type reference (TYPE)	CFX_C1		Charakterfeld für allgem. Zwecke	20010828

Method SET_SEARCH_AS_FINISHED on class CL_CFX_P_SEARCH has no exception.

Method START_SEARCH_SYNC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_MAX	Call by reference	☐	Type reference (TYPE)	I			20010926
2	Importing	I_SEARCHID	Call by reference	☐	Type reference (TYPE)	GUID_32		GUID im 'CHAR' Format in Großschreibung	20010926
3	Importing	I_USER	Call by reference	☐	Type reference (TYPE)	CFX_USERID		User Id	20010926

Method START_SEARCH_SYNC on class CL_CFX_P_SEARCH has no exception.

Method UPDATE_RESULTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_COUNT	Call by reference	☐	Type reference (TYPE)	I			20010919
2	Importing	I_SEARCHID	Call by reference	☐	Type reference (TYPE)	GUID_32		GUID im 'CHAR' Format in Großschreibung	20010919
3	Importing	I_SEARCH_RESULTS	Call by reference	☐	Type reference (TYPE)	XSTRING			20010919

Method UPDATE_RESULTS on class CL_CFX_P_SEARCH has no exception.

Method UPDATE_SEARCH_SYNC Signature

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

Method UPDATE_SEARCH_SYNC on class CL_CFX_P_SEARCH has no exception.

History

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