All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ComponentsCatalogsInterfaces Interface CATICatalogQuery

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

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


interface CATICatalogQuery

Interface to launch a temprorary query on a catalog chapter.
Role:This interface, implemented by the catalog's chapter, CATICatalogChapter, enables to filter chapter's descriptions.
To retrieve the filtered descriptions use the methods of the CATICatalogQueryResult interface.

See also:
CATICatalogPersistentQuery


Method Index


o Query(CATICatalogQueryResult*&,CATUnicodeString&,int)
Launches a query on the current chapter.

Methods


o Query
public virtual HRESULT Query(CATICatalogQueryResult*& oQueryResult,
const CATUnicodeString& iQueryExpression="",
const int iQueryMode= 0) = 0
Launches a query on the current chapter.
Role:This method enables to filter a chapter in using its keywords. The query is not recursive. It means that if the chapter contains sub-chapters, the research is only done on the descriptions of the current chapter.
Parameters:
oQueryResult
[out, CATBaseUnknown#Release] The result of the query.
iQueryExpression
The expression of the query.
It has a knowledgeware syntax and the available operators are:
  • +,-,*,/,(,),**,==,<>,<,>,<=,>=
  • abs,sqrt,cos,sin,tan,log,min,max ...
  • Search,Extract,Length,ToUpper ...
  • if ... then.., and,or,...
An example:
       (x.DIAMETER  <=  4)AND(x.TYPE == "FHC")
       where DIAMETER and TYPE are keywords of the Chapter.
       
iQueryMode
Not use. Lets the default value 0

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

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