SAP ABAP Class CL_CFX_SEARCH_RESULT (CFX Search: Search Result)
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_SEARCH_RESULT  
Short Description CFX Search: Search Result    
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 IXML Type group use (TYPE-POOLS tp)  Type group use (TYPE-POOLS tp)
Interfaces
Class CL_CFX_SEARCH_RESULT has no interface implemented.
Friends
# Friend Modeled only Created on Description
1 CL_CFX_SEARCH_APPLICATION 20010828 CFX Search: Application Singleton
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 MT_ALLFOUNDOBJECTS Instance attribute Private Type reference (TYPE) TYPE_FOUNDOBJECTLIST 20010918
2 MT_FOUND_OBJECTS Instance attribute Public Type reference (TYPE) CFX_TT_SEARCH_OBJECT CFX Search: List of Found Objects 20010828
3 MT_VISIBLE_OBJECTS Instance attribute Public Type reference (TYPE) CFX_TT_VISIBLE_IN_SEARCH CFX Search: Objects (docs...) that a user is allowed to see 20010917
4 SC_TAG_AREAID Constant Private Type reference (TYPE) TEXT10 'AreaId' 'AreaID' 20010828
5 SC_TAG_COLID Constant Private Type reference (TYPE) TEXT10 'ColId' 'CollID' 20010828
6 SC_TAG_DOCID Constant Private Type reference (TYPE) TEXT10 'DocId' 'DocID' 20010828
7 SC_TAG_FOLID Constant Private Type reference (TYPE) TEXT10 'FolId' 'FolID' 20010828
8 SC_TAG_MATCHREASON Constant Private Type reference (TYPE) TEXT10 'Match' 'Match' 20010910
9 SC_TAG_MATCHREASONID Constant Private Type reference (TYPE) TEXT10 'MatchId' 'MatchID' 20010927
10 SC_TAG_MATCHREASONTX Constant Private Type reference (TYPE) TEXT10 'MatchTx' 'MatchTx' 20010927
11 SC_TAG_OBJDESC Constant Private Type reference (TYPE) TEXT10 'Desc' 'Desc' 20010910
12 SC_TAG_OBJNAME Constant Private Type reference (TYPE) TEXT10 'Name' 'Name' 20010910
13 SC_TAG_OBJTYPE Constant Private Type reference (TYPE) TEXT10 'ObjType' 'ObjType' 20010828
14 SC_TAG_OBJTYPE_DESC Constant Private Type reference (TYPE) TEXT10 'ObjTDesc' 'ObjTDesc' 20030128
15 SC_TAG_RESULTENV Constant Private Type reference (TYPE) TEXT10 'Result' 'Result' 20010828
16 SC_TAG_RESULTOBJ Constant Private Type reference (TYPE) TEXT10 'Object' 'Object' 20010828
17 SC_TAG_TOPICID Constant Private Type reference (TYPE) TEXT10 'TopicId' 'TopicID' 20010828
18 SC_TAG_USERGROUPID Constant Private Type reference (TYPE) TEXT10 'Usergrp' 'Usergrp' 20020213
19 SC_TAG_USERID Constant Private Type reference (TYPE) TEXT10 'User' 'User' 20020213
Methods
# Method Level Visibility Method type Description Created on
1 ADD_FOUND_OBJECT Instance method Public Method Add Object Found as Part of a Search 20010824
2 ADD_OBJECT Instance method Public Method Add Object with All Possible IDs 20020104
3 ADD_VISIBLE_OBJECT Instance method Private Method Note Visible Object as Part of a Search 20010917
4 CONTAINS_OBJECT Instance method Public Method Delivers True, If the Object is in the Hitlist 20010919
5 CREATE Static method Public Method Generate New (Empty) Instance 20010824
6 CREATE_FROM_XML Static method Private Method Generate Instance from XML 20010828
7 GET_XML Instance method Private Method Convert Result by XML 20010824
8 IS_VISIBLE_OBJECT Instance method Private Method If Object with Specified GUID Already Appeared in Search 20020405
9 MERGE_RESULTS Instance method Public Method Mix In Results of Another Results List 20030528
10 REMOVE_OBJECT Instance method Public Method Remove Individual Object from Hitlist 20020528
11 REMOVE_OBJECTS Instance method Public Method Remove Object from Hitlist 20010919
12 REMOVE_OBJECTS_FROM_COL Instance method Public Method Remove Object with Collaboration Reference from Hitlist 20020716
13 RESET Instance method Public Method Empties Previous Hitlist 20010918
Events
Class CL_CFX_SEARCH_RESULT has no event.
Types
# Type Visibility Typing Associated Type Description Created on Type Source
1 TYPE_FOUNDOBJECTLIST Private See coding 20010918
Method Signatures

Method ADD_FOUND_OBJECT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IP_OBJECT_REF Call by reference Object reference (TYPE REF TO) IF_CFX_COMMON Gemeinsame Schnittstelle aller Objekte 20020731
2 Importing IT_MATCH_REASONS Call by reference Type reference (TYPE) CFX_TT_MATCHEDWORDS CFX Suchen: Liste gematchter Kontexte 20010927
3 Importing I_AREA_ID Call by reference Type reference (TYPE) GUID_32 GUID im 'CHAR' Format in Großschreibung 20010827
4 Importing I_COL_ID Call by reference Type reference (TYPE) GUID_32 GUID im 'CHAR' Format in Großschreibung 20010827
5 Importing I_DOC_ID Call by reference Type reference (TYPE) GUID_32 GUID im 'CHAR' Format in Großschreibung 20010827
6 Importing I_FOL_ID Call by reference Type reference (TYPE) GUID_32 GUID im 'CHAR' Format in Großschreibung 20010827
7 Importing I_OBJECT_DESC Call by reference Type reference (TYPE) CFX_STRING Zeichenkette für Collaboration Folders 20010910
8 Importing I_OBJECT_NAME Call by reference Type reference (TYPE) CFX_STRING Zeichenkette für Collaboration Folders 20010910
9 Importing I_TOPIC_ID Call by reference Type reference (TYPE) GUID_32 GUID im 'CHAR' Format in Großschreibung 20010827

Method ADD_FOUND_OBJECT on class CL_CFX_SEARCH_RESULT has no exception.

Method ADD_OBJECT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IP_OBJECT_REF Call by reference Object reference (TYPE REF TO) IF_CFX_COMMON Gemeinsame Schnittstelle aller Objekte 20020731
2 Importing IT_MATCH_REASONS Call by reference Type reference (TYPE) CFX_TT_MATCHEDWORDS CFX Suchen: Liste gematchter Kontexte 20020213
3 Importing I_AREA_ID Call by reference Type reference (TYPE) GUID_32 GUID im 'CHAR' Format in Großschreibung 20020104
4 Importing I_COL_ID Call by reference Type reference (TYPE) GUID_32 GUID im 'CHAR' Format in Großschreibung 20020104
5 Importing I_DOC_ID Call by reference Type reference (TYPE) GUID_32 GUID im 'CHAR' Format in Großschreibung 20020104
6 Importing I_FOL_ID Call by reference Type reference (TYPE) GUID_32 GUID im 'CHAR' Format in Großschreibung 20020213
7 Importing I_OBJECT_DESC Call by reference Type reference (TYPE) CFX_STRING Zeichenkette für Collaboration Folders 20020104
8 Importing I_OBJECT_NAME Call by reference Type reference (TYPE) CFX_STRING Zeichenkette für Collaboration Folders 20020104
9 Importing I_OBJECT_TYPE Call by reference Type reference (TYPE) CFX_T_OBJECT_TYPE Objekttyp 20020104
10 Importing I_OBJECT_TYPE_DESC Call by reference Type reference (TYPE) CFX_ID Interne ID der Typisierung 20030128
11 Importing I_REFRESH Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE Wenn true, wird das Objekt überschrieben 20020814
12 Importing I_TOPIC_ID Call by reference Type reference (TYPE) GUID_32 GUID im 'CHAR' Format in Großschreibung 20020104
13 Importing I_USERGROUP_ID Call by reference Type reference (TYPE) GUID_32 GUID im 'CHAR' Format in Großschreibung 20020213
14 Importing I_USER_ID Call by reference Type reference (TYPE) SYUNAME Anmeldename des Benutzers 20020213

Method ADD_OBJECT on class CL_CFX_SEARCH_RESULT has no exception.

Method ADD_VISIBLE_OBJECT 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 20030121
2 Importing I_AREA_ID Call by reference Type reference (TYPE) GUID_32 GUID im 'CHAR' Format in Großschreibung 20010917
3 Importing I_COL_ID Call by reference Type reference (TYPE) GUID_32 GUID im 'CHAR' Format in Großschreibung 20010917
4 Importing I_DOC_ID Call by reference Type reference (TYPE) GUID_32 GUID im 'CHAR' Format in Großschreibung 20010917
5 Importing I_FOL_ID Call by reference Type reference (TYPE) GUID_32 GUID im 'CHAR' Format in Großschreibung 20010917
6 Importing I_TOPIC_ID Call by reference Type reference (TYPE) GUID_32 GUID im 'CHAR' Format in Großschreibung 20010917

Method ADD_VISIBLE_OBJECT on class CL_CFX_SEARCH_RESULT has no exception.

Method CONTAINS_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 20010919
2 Returning R_FOUND Value transfer Type reference (TYPE) ABAP_BOOL 20010919

Method CONTAINS_OBJECT on class CL_CFX_SEARCH_RESULT has no exception.

Method CREATE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RP_RES Value transfer Object reference (TYPE REF TO) CL_CFX_SEARCH_RESULT CFX Suchen: Suchergebnis 20010824

Method CREATE on class CL_CFX_SEARCH_RESULT 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 20010828
2 Returning RP_RESULT Value transfer Object reference (TYPE REF TO) CL_CFX_SEARCH_RESULT CFX Suchen: Suchergebnis 20010828

Method CREATE_FROM_XML on class CL_CFX_SEARCH_RESULT 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_RESULT has no exception.

Method IS_VISIBLE_OBJECT Signature

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

Method IS_VISIBLE_OBJECT on class CL_CFX_SEARCH_RESULT has no exception.

Method MERGE_RESULTS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IP_OTHER_RESULT Call by reference Object reference (TYPE REF TO) CL_CFX_SEARCH_RESULT CFX Suchen: Suchergebnis 20030528

Method MERGE_RESULTS on class CL_CFX_SEARCH_RESULT has no exception.

Method REMOVE_OBJECT Signature

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

Method REMOVE_OBJECT on class CL_CFX_SEARCH_RESULT has no exception.

Method REMOVE_OBJECTS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_OBJECT_IDS Call by reference Type reference (TYPE) CFX_TT_GUID_32 Tabelle mit guids 20010919

Method REMOVE_OBJECTS on class CL_CFX_SEARCH_RESULT has no exception.

Method REMOVE_OBJECTS_FROM_COL Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing I_COL_ID Call by reference Type reference (TYPE) GUID_32 col id 20020716

Method REMOVE_OBJECTS_FROM_COL on class CL_CFX_SEARCH_RESULT has no exception.

Method RESET Signature

Method RESET on class CL_CFX_SEARCH_RESULT has no parameter.
Method RESET on class CL_CFX_SEARCH_RESULT has no exception.
History
Last changed by/on SAP  20141109 
SAP Release Created in 100