All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ComponentsCatalogsInterfaces Interface CATICatalogQueryResult

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

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


interface CATICatalogQueryResult

Interface to inquire query results.

Role: This interface is used to inquire query results. A query is the means to filter the descriptions of a chapter in taken account of a criteria. A criteria is a set of conditions that must resolve the keywords of the chapters. Each description resolving the query has keyword values filling the criteria.
The query result is a temporary object which is not included in the catalog document. This interface is a handle on this object. There are three cases to have a such object:


Method Index


o AsAList(CATListValCATICatalogDescription_var*&)
Retrieves the list of descriptions.
o GetChapter(CATICatalogChapter*&)
Retrieves the chapter from the current query.
o GetQuery()
Returns the knowledge expression of the current query.
o GetQueryMode()
Returns the type of the query.
o Size()
Returns the number of descriptions solving the query.

Methods


o AsAList
public virtual HRESULT AsAList(CATListValCATICatalogDescription_var*& oListDescriptions) = 0
Retrieves the list of descriptions.
Parameters:
oListDescriptions
The list of descriptions which is the result of the query.
o GetChapter
public virtual HRESULT GetChapter(CATICatalogChapter*& oChapter) = 0
Retrieves the chapter from the current query.
Parameters:
oChapter
[out, CATBaseUnknown#Release] The chapter to which the query has been applied.
o GetQuery
public virtual CATUnicodeString GetQuery()= 0
Returns the knowledge expression of the current query.
Returns:
The query expression. It can be an empty string.
o GetQueryMode
public virtual int GetQueryMode()= 0
Returns the type of the query.
Returns:
The type of the query.there are two possibilities:
  • 1:It is the result of a persistent query on the chapter.
  • 0:Otherwise
o Size
public virtual int Size()= 0
Returns the number of descriptions solving the query.
Returns:
Retrieves the number of descriptions.

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

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