All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

VPMXBom Interface ENOVIQuery

System.IUnknown
  |
  +---ENOVIQuery
 

Usage: you can freely reimplement this interface.


interface ENOVIQuery

Interface representing a Query.
Role Queries are done by type so each pointer on an ENOVIQuery interface can be used to query only for objects of a given type, if another query is needed, one must obtain a pointer on another interface through the use of an ENOVIAttributeDefinitions.


Method Index


o get_QueryCriteria(ENOVIBase**)
Gets the Query criteria if no criteria was set returns an empty one
o get_Results(CATIUnknownList**)
Get the current results.
o runQuery()
Runs the Query.
o set_QueryCriteria(ENOVIBase*)
Sets a Query criteria.

Methods


o get_QueryCriteria
public virtual HRESULT __stdcall get_QueryCriteria(ENOVIBase** oCriteria)=0
Gets the Query criteria if no criteria was set returns an empty one
o get_Results
public virtual HRESULT __stdcall get_Results(CATIUnknownList** oResults)=0
Get the current results. the Query can still be running in which case the resultset will be updated repeatedly.
Parameters:
oResults
the returned results. It should be tested for NULL since a query which was not run since the last call to set_QueryCriteria will return S_OK and set the value of *oResults to NULL
Returns:
S_OK results are completed and all went fine
Returns:
S_FALSE query is still running, partial results are being returned
Returns:
E_* something bad happened
o runQuery
public virtual HRESULT __stdcall runQuery()=0
Runs the Query. the Query can be synchron or asynchrone, the runQuery is allowed to return before the results are filled
Returns:
S_OK Query ran, results are up to date.
Returns:
S_FALSE Query is running asynchronously, results are being filled.
Returns:
E_* something bad happened
o set_QueryCriteria
public virtual HRESULT __stdcall set_QueryCriteria(ENOVIBase* iCriteria)=0
Sets a Query criteria.
Role: The EFC query works with a Query by example metaphore: the ENOVIQuery interface can be used to obtain an empty criteria (i.e. an empty object with the same attributes as those in the type queried) and to a Query criteria is a partially filled ENOVIBase of type matching the type queried and with individual clauses filling each attribute values.

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

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