All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

InteractiveInterfaces Interface CATIIniSearchEngine

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATIIniSearchEngine
 

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface CATIIniSearchEngine

Interface to launch the search engine and retrieve the results.
Role: This interface enables the user to launch the search engine with the given criterion, context, and possibly document.
The results can be retrieved as a pointer to a CATSO instance.


Method Index


o GetFoundObjects(CATSO*&)
Retrieves the list of found objects.
o LaunchSearchOnDocument(CATDocument*)
Launches the Search process.
o SetCriterionAndContext(CATIIniSearchCriterion*,CATIIniSearchContext*)
Sets up the necessary data.

Methods


o GetFoundObjects
public virtual HRESULT GetFoundObjects(CATSO*& oListOfFoundObjects) = 0
Retrieves the list of found objects.
Role: This method enables to retrieve the list of objects that are matching the input criterion, in the input context, and in the specified document.
Parameters:
oListOfFoundObjects
The list of found objects
Returns:
  • E_FAIL if no element has been found.
  • S_OK otherwise.
o LaunchSearchOnDocument
public virtual HRESULT LaunchSearchOnDocument( const CATDocument* iDocument= NULL) = 0
Launches the Search process.
Role: This method launches the Search process for the criterion and context has specified in the SetCriterionAndContext method, and for the specified Document.
If no document is specified, the current document is being used.
Parameters:
iDocument
The document in which the Search will take place.
If no document is specified, the current document is being used.
Returns:
S_OK always.
o SetCriterionAndContext
public virtual HRESULT SetCriterionAndContext( const CATIIniSearchCriterion* iCriterion,
const CATIIniSearchContext* iContext) = 0
Sets up the necessary data.
Role: This method sets up the necessary criterion and context.
Those data are vital for appropriatly launching the search engine.
If iContext is NULL, the default context will be applied ( CATIIniSearchContext.InUIActiveObject ).
Parameters:
iCriterion
The criterion to which objects will be confronted.
iContext
The context to determine which objects will be confronted to the criterion. If iContext is NULL, the default context will apply.
Returns:
  • E_FAIL if iCriterion is NULL.
  • S_OK otherwise.

This object is included in the file: CATIIniSearchEngine.h
If needed, your Imakefile.mk should include the module: CATInteractiveInterfaces

Copyright © 2003, Dassault Systèmes. All rights reserved.