All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ENOVInterfaces Interface CATIEnovCMEffectivity

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

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


interface CATIEnovCMEffectivity

Interface for ENOVIA_ECO object implementation.

Role: This interface is implemented in ENOVCMImplSDM/VX0CMEFF module Customers must use this interface with the provided implementation.


Method Index


o GetCfgView(CATUnicodeString&)
Gets the value of V_cfgview.
o GetEffDveId(CATUnicodeString&)
Gets the value of V_deliverable_id.
o GetProdId(CATUnicodeString&)
Gets the value of V_product_id.
o GetRelatedEco(CATIEnovCMEco_var&)
Retrieves the parent of a Related ECO.
o SetCfgView(CATUnicodeString&)
Sets the value of V_cfgview.
o SetEffDveId(CATUnicodeString&)
Sets the value of V_deliverable_id.
o SetProdId(CATUnicodeString&)
Sets the value of V_product_id.

Methods


o GetCfgView
public virtual HRESULT GetCfgView(CATUnicodeString& oValue)=0
Gets the value of V_cfgview.
Parameters:
oValueOutput
value of the ECO cfgview attribute
Returns:
An HRESULT.
Legal values:
S_OK
The query is successful and the interface pointer is successfully returned
E_FAIL
The query is successful, but the interface query fails
o GetEffDveId
public virtual HRESULT GetEffDveId(CATUnicodeString& oValue)=0
Gets the value of V_deliverable_id.
Parameters:
oValueOutput
value of the effectivity deliverable ID.
Returns:
An HRESULT.
Legal values:
S_OK
The query is successful and the interface pointer is successfully returned
S_FALSE
The query is successful, but the deliverable name is empty; the interface pointer is successfully returned
E_FAIL
The query is successful, but the interface query fails
o GetProdId
public virtual HRESULT GetProdId(CATUnicodeString& oValue)=0
Gets the value of V_product_id.
Parameters:
oValueOutput
value of the ECO product ID attribute
Returns:
An HRESULT.
Legal values:
S_OK
The query is successful and the interface pointer is successfully returned
E_FAIL
The query is successful, but the interface query fails
o GetRelatedEco
public virtual HRESULT GetRelatedEco(CATIEnovCMEco_var& oeco)=0
Retrieves the parent of a Related ECO.
Parameters:
oecoOutput
value of the parent ECO
Returns:
An HRESULT.
Legal values:
S_OK
The query is successful and the interface pointer is successfully returned
E_FAIL
The query is successful, but the interface query fails
o SetCfgView
public virtual HRESULT SetCfgView( const CATUnicodeString& iValue)=0
Sets the value of V_cfgview.
Parameters:
iValueInput
value of the effectivity cfgview
Returns:
An HRESULT.
Legal values:
S_OK
The component is successfully created and the interface pointer is successfully returned
E_FAIL
The component is successfully created, but the interface query fails
o SetEffDveId
public virtual HRESULT SetEffDveId( const CATUnicodeString& ivalue) =0
Sets the value of V_deliverable_id.
Parameters:
iValueInput
value of the effectivity deliverable ID.
Returns:
An HRESULT.
Legal values:
S_OK
The component is successfully created and the interface pointer is successfully returned
E_FAIL
The component is successfully created, but the interface query fails
o SetProdId
public virtual HRESULT SetProdId( const CATUnicodeString& iValue)=0
Sets the value of V_product_id.
Parameters:
iValueInput
value of the effectivity cfgview
Returns:
An HRESULT.
Legal values:
S_OK
The component is successfully created and the interface pointer is successfully returned
E_FAIL
The component is successfully created, but the interface query fails

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

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