All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ENOVInterfaces Interface ENOVIABOProductClass

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---System.CATBaseDispatch
        |
        +---System.CATIABase
          |
          +---ENOVInterfaces.ENOVIABusinessObject
            |
            +---ENOVIABOProductClass
 

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


interface ENOVIABOProductClass

Interface to create and manage Product Class objects.
Role: A Product Class role is to create Product Root Class objects, and it is also a container for those Product Root Classes.

See also:
ENOVIABusinessObject, ENOVIABOProductRootClass


Method Index


o AggregateProductClass(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,ENOVIABOProductClass*&)
Creates a new ProductClass and adds it to the current ProductClass.
o AggregateProductClass(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,ENOVIABOProductClass*&)
o AggregateProductRootClass(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,ENOVIABOProductRootClass*&)
Creates a new ProductRootClass and adds it to the current ProductRootClass.
o AggregateProductRootClass(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,ENOVIABOProductRootClass*&)
o get_ParentProductClass(ENOVIABOProductClass*&)
Retrieves the parent ProductClass of the current ProductClass.
o get_ProductClass(long,ENOVIABOProductClass*&)
Retrieves the ProductClass for a given index.
o get_ProductClassCount(long&)
Retrieves the number of ProductClass of the current ProductClass.
o get_ProductRootClass(long,ENOVIABOProductRootClass*&)
Retrieves the ProductRootClass for a given index.
o get_ProductRootClassCount(long&)
Retrieves the number of ProductRootClass of the current ProductClass.

Methods


o AggregateProductClass
public virtual HRESULT __stdcall AggregateProductClass( const CATUnicodeString& id,
const CATUnicodeString& name,
const CATUnicodeString& description,
const CATUnicodeString& environment,
ENOVIABOProductClass*& ProductClass)= 0
Creates a new ProductClass and adds it to the current ProductClass.
Parameters:
id
The identifier of the ProductClass to create (mandatory).
name
The name of the ProductClass to create (optional).
description
The description of the ProductClass to create (optional).
environment
The environment in which the ProductClass will be created (mandatory).
ProductClass
The created ProductClass.
Returns:
S_OK in case of success, E_FAIL in case of error.
o AggregateProductClass
public virtual HRESULT __stdcall AggregateProductClass( const CATUnicodeString& id,
const CATUnicodeString& name,
const CATUnicodeString& description,
ENOVIABOProductClass*& ProductClass)= 0
Deprecated:
V5R15 Creates a new ProductClass and adds it to the current ProductClass.
Parameters:
id
The identifier of the ProductClass to create (mandatory).
name
The name of the ProductClass to create (optional).
description
The description of the ProductClass to create (optional).
ProductClass
The created ProductClass.
Returns:
S_OK in case of success, E_FAIL in case of error.
o AggregateProductRootClass
public virtual HRESULT __stdcall AggregateProductRootClass( const CATUnicodeString& id,
const CATUnicodeString& name,
const CATUnicodeString& description,
const CATUnicodeString& environment,
ENOVIABOProductRootClass*& ProductRootClass)= 0
Creates a new ProductRootClass and adds it to the current ProductRootClass.
Parameters:
id
The identifier of the ProductRootClass to create (mandatory).
name
The name of the ProductRootClass to create (optional).
description
The description of the ProductRootClass to create (optional).
environment
The environment in which the ProductRootClass will be created (mandatory).
ProductRootClass
The created ProductRootClass.
Returns:
S_OK in case of success, E_FAIL in case of error.
o AggregateProductRootClass
public virtual HRESULT __stdcall AggregateProductRootClass( const CATUnicodeString& id,
const CATUnicodeString& name,
const CATUnicodeString& description,
ENOVIABOProductRootClass*& ProductRootClass)= 0
Deprecated:
V5R15 Creates a new ProductRootClass and adds it to the current ProductRootClass.
Parameters:
id
The identifier of the ProductRootClass to create (mandatory).
name
The name of the ProductRootClass to create (optional).
description
The description of the ProductRootClass to create (optional).
ProductRootClass
The created ProductRootClass.
Returns:
S_OK in case of success, E_FAIL in case of error.
o get_ParentProductClass
public virtual HRESULT __stdcall get_ParentProductClass(ENOVIABOProductClass*& ProductClass)= 0
Retrieves the parent ProductClass of the current ProductClass.
Parameters:
ProductClass
The parent ProductClass.
Returns:
S_OK in case of success, E_FAIL in case of error.
o get_ProductClass
public virtual HRESULT __stdcall get_ProductClass(long index,
ENOVIABOProductClass*& ProductClass)= 0
Retrieves the ProductClass for a given index. It must be called after the get_ProductClassCount method.
Parameters:
index
The index of loop, from 1 to NbItems.
ProductClass
The ProductClass at the given index.
Returns:
S_OK in case of success, E_FAIL in case of error.
o get_ProductClassCount
public virtual HRESULT __stdcall get_ProductClassCount(long& NbItems)= 0
Retrieves the number of ProductClass of the current ProductClass.
Parameters:
NbItems
The number of ProductClass.
Returns:
S_OK in case of success, E_FAIL in case of error.
o get_ProductRootClass
public virtual HRESULT __stdcall get_ProductRootClass(long index,
ENOVIABOProductRootClass*& ProductRootClass)= 0
Retrieves the ProductRootClass for a given index. It must be called after the get_ProductRootClassCount method.
Parameters:
index
The index of loop, from 1 to NbItems.
ProductRootClass
The ProductRootClass at the given index.
Returns:
S_OK in case of success, E_FAIL in case of error.
o get_ProductRootClassCount
public virtual HRESULT __stdcall get_ProductRootClassCount(long& NbItems)= 0
Retrieves the number of ProductRootClass of the current ProductClass.
Parameters:
NbItems
The number of ProductRootClass.
Returns:
S_OK in case of success, E_FAIL in case of error.

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

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