Package com.documentum.fc.client.search
Interface IDfSearchService
public interface IDfSearchService
This interface is the factory for search objects.
-
Method Summary
Modifier and TypeMethodDescriptionGets the list of sources that are currently available for search.Creates a new IDfQueryManager.newQueryProcessor
(IDfQueryDefinition query, boolean removeDuplicate) Creates a new IDfQueryProcessor.Creates a new IDfResultObjectManager.Creates a new IDfResultManipulator.
-
Method Details
-
getSourceMap
IDfSearchSourceMap getSourceMap()Gets the list of sources that are currently available for search.- Returns:
- A map of sources with both repositories and external sources.
-
newQueryMgr
IDfQueryManager newQueryMgr()Creates a new IDfQueryManager. This is used to build, save and load a query.- Returns:
- A new IDfQueryManager instance.
-
newResultsManipulator
Creates a new IDfResultManipulator.- Parameters:
query
- The query whose results will be manipulated by the result manipulator.- Returns:
- A new IDfResultManipulator instance.
-
newQueryProcessor
Creates a new IDfQueryProcessor. Once a query has been created or loaded using IDfQueryManager, the query processor is used to execute it.- Parameters:
query
- A query definition to execute.removeDuplicate
- Indicates how duplicates in the results should be treated. In most case, this parameter should be set to true.- Returns:
- A new IDfQueryProcessor instance.
-
newResultObjectManager
Creates a new IDfResultObjectManager. This is used to get the content of external results and get an IDfSysObject from repository results.- Parameters:
query
- The query whose results will be handled by the result object manager.- Returns:
- A new IDfResultObjectManager
-