All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

VPMDesktopObjects Interface CATIAVPMVDAExists

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---System.CATBaseDispatch
        |
        +---System.CATIABase
          |
          +---VPMDesktopObjects.CATIAVPMVDACommand
            |
            +---CATIAVPMVDAExists
 

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


interface CATIAVPMVDAExists

Interface to query a Business Object with criterias.
Role: This interface is designed to search Business Objects in database and in memory, to get interfaces on them. The criterias used are the type of the object and its identifier, sometimes its version if this attribute is defined on the object.


Method Index


o ExistsInDataBase()
Sets the query in database only.
o ExistsInDataBaseAndMemory()
Sets the query in database and memory.
o get_BObject(ENOVIABusinessObject*&)
Gets the object result of the query.
o get_BObjectExists(CATBoolean&)
Gets the existence of a result for the query.
o put_ID(CATUnicodeString&)
Sets the identifier of the object to query.
o put_Type(CATUnicodeString&)
Sets the type of the object to query.
o put_Version(CATUnicodeString&)
Sets the version of the object to query.

Methods


o ExistsInDataBase
public virtual HRESULT __stdcall ExistsInDataBase()= 0
Sets the query in database only. If this method is called just before executing the command, the query will be done only in database, not in memory. So, only saved object will be found.
Returns:
Always S_OK.
o ExistsInDataBaseAndMemory
public virtual HRESULT __stdcall ExistsInDataBaseAndMemory()= 0
Sets the query in database and memory. This is the default. If this method is called just before executing the command, the query will be done in database and in memory. All objects will be found, even those created but not saved yet.
Returns:
Always S_OK.
o get_BObject
public virtual HRESULT __stdcall get_BObject(ENOVIABusinessObject*& oObject)= 0
Gets the object result of the query. The pointer can be null if no object matches the given criteria.
Parameters:
oObject
The object matching the criteria - can be null.
Returns:
Always S_OK.
o get_BObjectExists
public virtual HRESULT __stdcall get_BObjectExists(CATBoolean& oExists)= 0
Gets the existence of a result for the query. This method tells if an object matches the given criteria or not.
Parameters:
oExists
True if an object exists given the criteria, false otherwise.
Returns:
Always S_OK.
o put_ID
public virtual HRESULT __stdcall put_ID( const CATUnicodeString& iId)= 0
Sets the identifier of the object to query.
Parameters:
iId
The identifier of the object.
Returns:
Always S_OK.
o put_Type
public virtual HRESULT __stdcall put_Type( const CATUnicodeString& iType)= 0
Sets the type of the object to query.
Parameters:
iType
Type of the object.
Returns:
Always S_OK.
o put_Version
public virtual HRESULT __stdcall put_Version( const CATUnicodeString& iVersion)= 0
Sets the version of the object to query.
Parameters:
iVersion
The version of the object.
Returns:
Always S_OK.

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

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