All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ENOVInterfaces Interface ENOVIConfigProductSpec

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

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


interface ENOVIConfigProductSpec

Interface to create ProductSpecifications .
Role: The ENOVIConfigProductSpec enables you to:


Method Index


o CreateCarryOverProductSpecification(CATUnicodeString&,CATIAVPMProductRootClass_var&,CATIAVPMProductSpecification2_var&)
Creates a CarryOver ProductSpecification.
o CreateCarryOverProductSpecification(CATUnicodeString&,CATUnicodeString&,CATIAVPMProductSpecification2_var&)
Creates a CarryOver ProductSpecification.
o CreateProductSpecification(CATUnicodeString&,CATUnicodeString&,CATIAVPMProductRootClass_var&,CATListOfCATICfgSimpleSpecification_var&,CATListOfCATICfgNormalValue_var&,CATIAVPMProductSpecification2_var&)
Creates a ProductSpecification.
o CreateProductSpecification(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATListOfCATUnicodeString&,CATListOfCATICfgNormalValue_var&,CATIAVPMProductSpecification2_var&)
Creates a ProductSpecification.
o DeleteProductSpecification(CATIAVPMProductSpecification2_var&)
Deletes a ProductSpecification.
o DeleteProductSpecification(CATUnicodeString&,CATUnicodeString&)
Deletes a ProductSpecification.
o EditProductSpecification(CATIAVPMProductSpecification2_var&,CATUnicodeString&,CATIAVPMProductRootClass_var&,CATListOfCATICfgSimpleSpecification_var&,CATListOfCATICfgNormalValue_var&)
Edits a ProductSpecification's filter values.
o EditProductSpecification(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATListOfCATUnicodeString&,CATListOfCATICfgNormalValue_var&)
Edits a ProductSpecification's filter values.
o GetProductSpecification(CATUnicodeString&,CATUnicodeString&,CATIAVPMProductSpecification2_var&)
Retrieves a ProductSpecification.

Methods


o CreateCarryOverProductSpecification
public virtual HRESULT CreateCarryOverProductSpecification( const CATUnicodeString& iPSName,
const CATIAVPMProductRootClass_var& iProduct,
CATIAVPMProductSpecification2_var& oProductSpecification)=0
Creates a CarryOver ProductSpecification.
Parameters:
iPSName
Input value - The Name of the CarryOver ProductSpec to be created
iProduct
Input value - The interface pointer of the Configured Product under which the CarryOver ProductSpec is to be created
oProductSpecification
Output value - The newly created CarryOver ProductSpecification
Returns:
An HRESULT
Legal values:
S_OK
The ProductSpec is successfully created and the interface pointer is successfully returned
S_FALSE
The ProductSpec is already existing
E_FAIL
Failed to create the ProductSpecification
o CreateCarryOverProductSpecification
public virtual HRESULT CreateCarryOverProductSpecification( const CATUnicodeString& iPSName,
const CATUnicodeString& iProductName,
CATIAVPMProductSpecification2_var& oProductSpecification)=0
Creates a CarryOver ProductSpecification.
Parameters:
iPSName
Input value - The Name of the CarryOver ProductSpec to be created
iProductName
Input value - The name of the Configured Product under which the CarryOver ProductSpec is to be created
oProductSpecification
Output value - The newly created CarryOver ProductSpecification
Returns:
An HRESULT
Legal values:
S_OK
The ProductSpec is successfully created and the interface pointer is successfully returned
S_FALSE
The ProductSpec is already existing
E_FAIL
Failed to create the ProductSpecification
o CreateProductSpecification
public virtual HRESULT CreateProductSpecification( const CATUnicodeString& iPSName,
const CATUnicodeString& iDomain,
const CATIAVPMProductRootClass_var& iProduct,
const CATListOfCATICfgSimpleSpecification_var& iSpec,
const CATListOfCATICfgNormalValue_var& listNV,
CATIAVPMProductSpecification2_var& oProductSpecification)=0
Creates a ProductSpecification.
Parameters:
iPSName
Input value - The Name of the ProductSpec to be created
iDomain
Input value - The Name of the Domain for ProductSpec being created
iProduct
Input value - The interface pointer of the Configured Product under which the ProductSpec is to be created
iSpec
Input value - The list of Specifications which need to be set in ProductSpec to be created
listNV
Input value - The list of NormalValues(which contain date or range values) which need to be set in ProductSpec to be created
oProductSpecification
Output value - The newly created ProductSpecification
Returns:
An HRESULT
Legal values:
S_OK
The ProductSpec is successfully created and the interface pointer is successfully returned
S_FALSE
The ProductSpec is already existing
E_FAIL
Failed to create the ProductSpecification
o CreateProductSpecification
public virtual HRESULT CreateProductSpecification( const CATUnicodeString& iPSName,
const CATUnicodeString& iDomain,
const CATUnicodeString& iProductName,
const CATListOfCATUnicodeString& iSpec,
const CATListOfCATICfgNormalValue_var& listNV,
CATIAVPMProductSpecification2_var& oProductSpecification)=0
Creates a ProductSpecification.
Parameters:
iPSName
Input value - The Name of the ProductSpec to be created
iDomain
Input value - The Name of the Domain for ProductSpec being created
iProductName
Input value - The Name of the Configured Product under which the ProductSpec is to be created
iSpec
Input value - The list of Specification names which need to be set in ProductSpec to be created
listNV
Input value - The list of NormalValues(which contain date or range values) which need to be set in ProductSpec to be created
oProductSpecification
Output value - The newly created ProductSpecification
Returns:
An HRESULT
Legal values:
S_OK
The ProductSpec is successfully created and the interface pointer is successfully returned
S_FALSE
The ProductSpec is already existing
E_FAIL
Failed to create the ProductSpecification
o DeleteProductSpecification
public virtual HRESULT DeleteProductSpecification( const CATIAVPMProductSpecification2_var& iPS)=0
Deletes a ProductSpecification.
Parameters:
iPS
Input value - The Name of the ProductSpec to be deleted
Returns:
An HRESULT
Legal values:
S_OK
The ProductSpec is successfully deleted
E_FAIL
Failed to delete ProductSpecification
o DeleteProductSpecification
public virtual HRESULT DeleteProductSpecification( const CATUnicodeString& iPSName,
const CATUnicodeString& iProductName)=0
Deletes a ProductSpecification.
Parameters:
iPSName
Input value - The Name of the ProductSpec to be deleted
iProductName
Input value - The Name of the Configured Product under which the ProductSpec is created
Returns:
An HRESULT
Legal values:
S_OK
The ProductSpec is successfully deleted
E_FAIL
Failed to delete ProductSpecification
o EditProductSpecification
public virtual HRESULT EditProductSpecification( const CATIAVPMProductSpecification2_var& iPS,
const CATUnicodeString& iDomain,
const CATIAVPMProductRootClass_var& iProduct,
const CATListOfCATICfgSimpleSpecification_var& iSpec,
const CATListOfCATICfgNormalValue_var& listNV)=0
Edits a ProductSpecification's filter values.
Parameters:
iPS
Input value - The interface pointer of the ProductSpec to be edited
iDomain
Input value - The Name of the Domain for ProductSpec being edited
iProduct
Input value - The interface pointer of the Configured Product under which the ProductSpec is to be edited
iSpec
Input value - The list of Specification which need to be set in ProductSpec to be edited
listNV
Input value - The list of NormalValues(which contain date or range values) which need to be set in ProductSpec to be edited
Returns:
An HRESULT
Legal values:
S_OK
The ProductSpec is successfully edited and the interface pointer is successfully returned
E_FAIL
Failed to edit the ProductSpecification
o EditProductSpecification
public virtual HRESULT EditProductSpecification( const CATUnicodeString& iPSName,
const CATUnicodeString& iDomain,
const CATUnicodeString& iProductName,
const CATListOfCATUnicodeString& iSpec,
const CATListOfCATICfgNormalValue_var& listNV)=0
Edits a ProductSpecification's filter values.
Parameters:
iPSName
Input value - The Name of the ProductSpec to be edited
iDomain
Input value - The Name of the Domain for ProductSpec being edited
iProductName
Input value - The Name of the Configured Product under which the ProductSpec is to be edited
iSpec
Input value - The list of Specification names which need to be set in ProductSpec to be edited
listNV
Input value - The list of NormalValues(which contain date or range values) which need to be set in ProductSpec to be edited
Returns:
An HRESULT
Legal values:
S_OK
The ProductSpec is successfully edited and the interface pointer is successfully returned
E_FAIL
Failed to edited the ProductSpecification
o GetProductSpecification
public virtual HRESULT GetProductSpecification( const CATUnicodeString& iPSName,
const CATUnicodeString& iProductName,
CATIAVPMProductSpecification2_var& oProductSpecification)=0
Retrieves a ProductSpecification.
Parameters:
iPSName
Input value - The Name of the ProductSpec to be retrieved
iProductName
Input value - The Name of the Configured Product under which the ProductSpec is created
Returns:
An HRESULT
Legal values:
S_OK
The ProductSpec is successfully retrieved and the interface pointer is successfully returned
E_FAIL
Failed to retrieve the ProductSpecification

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

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