All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ComponentsCatalogsInterfaces Interface CATICatalogPersistentQuery

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

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


interface CATICatalogPersistentQuery

Interface to manage a persistent query.
Role:The persistent query is used for creating a new family of descriptions. The CATICatalogChapter.AddPersistentQuery method enables to create an "empty" query. This method returns a pointer on this interface to complete and execute the query:

The result, that you have as output argument of the ResolveQuery method, by the GetGeneratedQueryResult method or by the GetListGeneratedDescriptions, are descriptions of the external catalog.

For each external description resolving the expression, a description is created on the family which has this persistent query. The only one keyword automatically valuated on this family is the "Name" keyword.

It is possible for each persistent query of a family to set new default values on each keywords of this family. It means that the value of a keyword of a description of such family can be:


Method Index


o GetChapter()
Returns the chapter which contain this current persistent query.
o GetExpression(CATUnicodeString&)
Retrieves the knowledge expression defining the query.
o GetGeneratedQueryResult(CATICatalogQueryResult*&)
Retrieves the result of the resolved query.
o GetListGeneratedDescriptions(CATListValCATICatalogDescription_var*&)
Retrieves the list of the resulting descriptions.
o GetResolutionChapter(CATICatalogChapter*&,int)
Retrieves the chapter on which the query would be solved.
o GetResolutionDate(CATTime&)
Retrieves the time/date of the resulting descriptions when the query is resolved.
o ResolveQuery(int,CATListValCATICatalogDescription_var*&)
Resolves the query that is defined by the knowledge expression.
o SetDefaultValue(CATUnicodeString&,CATBoolean)
Sets keyword Default Value for resolved attribute (boolean).
o SetDefaultValue(CATUnicodeString&,CATUnicodeString&)
Sets keyword Default Value for resolved attribute (string).
o SetDefaultValue(CATUnicodeString&,double)
Sets keyword Default Value for resolved attribute (real).
o SetDefaultValue(CATUnicodeString&,int)
Sets keyword Default Value for resolved attribute (integer).
o SetExpression(CATUnicodeString&)
Sets the knowledge expression defining the query.
o SetResolutionChapter(CATICatalogChapter*)
Sets the chapter on which the query would be solved to the current query.
o SetResolutionDate(CATTime&)
Sets the time/date of the resulting descriptions when the query is resolved.

Methods


o GetChapter
public virtual CATICatalogChapter* GetChapter()= 0
Returns the chapter which contain this current persistent query.
Returns:
The chapter containing this query.
o GetExpression
public virtual HRESULT GetExpression(CATUnicodeString& oExpression) = 0
Retrieves the knowledge expression defining the query.
Parameters:
oExpression
The defined query expression.
o GetGeneratedQueryResult
public virtual HRESULT GetGeneratedQueryResult(CATICatalogQueryResult*& oQueryResult) = 0
Retrieves the result of the resolved query.
Role:This method retrieves the descriptions which have resolved the query. The other way is to use the GetListGeneratedDescriptions method
Parameters:
oQueryResult
The generated descriptions.
o GetListGeneratedDescriptions
public virtual HRESULT GetListGeneratedDescriptions(CATListValCATICatalogDescription_var*& oListOfGeneratedDescriptions) = 0
Retrieves the list of the resulting descriptions.
Role:This method retrieves the descriptions which have resolved the query. The other way is to use the GetGeneratedQueryResult method
Parameters:
oListOfGeneratedDescriptions
The generated list of description.
o GetResolutionChapter
public virtual HRESULT GetResolutionChapter(CATICatalogChapter*& oChapter,
int iMode=1) = 0
Retrieves the chapter on which the query would be solved.
Parameters:
oChapter
The chapter on which the query would be solved.
iMode
0: search chapter only in session.
1: default try to load chapter.
o GetResolutionDate
public virtual HRESULT GetResolutionDate(CATTime& oResolutionTime) = 0
Retrieves the time/date of the resulting descriptions when the query is resolved.
Parameters:
oResolutionTime
The query resolved time stamp.
o ResolveQuery
public virtual HRESULT ResolveQuery( const int iResolveMode,
CATListValCATICatalogDescription_var*& ListOfDescriptions)= 0
Resolves the query that is defined by the knowledge expression.
Parameters:
iResolveMode
Options to output the result of the query:
0 = Simuluation : generate the result in the output list only.
1 = Generation : the generated result will be output and stored in the document.
ListOfDescriptions
The output list of the generated result.
o SetDefaultValue
public virtual HRESULT SetDefaultValue( const CATUnicodeString& ikwdName,
CATBoolean odefaultValue) = 0
Sets keyword Default Value for resolved attribute (boolean).
Parameters:
ikwdName
The name of the keyword.It is a keyword of the family which contains this persistent query.
odefaultValue
The default value for the keyword.
o SetDefaultValue
public virtual HRESULT SetDefaultValue( const CATUnicodeString& ikwdName,
CATUnicodeString& odefaultValue) = 0
Sets keyword Default Value for resolved attribute (string).
Parameters:
ikwdName
The name of the keyword.It is a keyword of the family which contains this persistent query.
odefaultValue
The default value for the keyword.
o SetDefaultValue
public virtual HRESULT SetDefaultValue( const CATUnicodeString& ikwdName,
double odefaultValue) = 0
Sets keyword Default Value for resolved attribute (real).
Parameters:
ikwdName
The name of the keyword.It is a keyword of the family which contains this persistent query.
odefaultValue
The default value for the keyword.
o SetDefaultValue
public virtual HRESULT SetDefaultValue( const CATUnicodeString& ikwdName,
int odefaultValue) = 0
Sets keyword Default Value for resolved attribute (integer).
Parameters:
ikwdName
The name of the keyword. It is a keyword of the family which contains this persistent query.
odefaultValue
The default value for the keyword.
o SetExpression
public virtual HRESULT SetExpression( const CATUnicodeString& iExpression) = 0
Sets the knowledge expression defining the query.
Parameters:
iExpression
The defined query expression.
o SetResolutionChapter
public virtual HRESULT SetResolutionChapter(CATICatalogChapter* iChapter) = 0
Sets the chapter on which the query would be solved to the current query.
Role:It is the root chapter of an another catalog.
Parameters:
iChapter
The chapter on which the query would be solved.
o SetResolutionDate
public virtual HRESULT SetResolutionDate( const CATTime& iResolutionTime) = 0
Sets the time/date of the resulting descriptions when the query is resolved.
Parameters:
oResolutionTime
The query resolved time stamp to be set.

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

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