All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATxPDMInterfaces Interface CATIxPDMProductItem

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

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


interface CATIxPDMProductItem

Interface to access any V5 Product item that can be stored in an external PDM system.
Role: Provide specific navigation and loading methods in Product items.

This interface is available only on items (CATIxPDMItem ) of type CATProduct loaded in session

All the methods pre-requisites the PX1 license

See also:
CATIxPDMItem, CATxPDMSessionServices


Method Index


o GetChildrenItems(CATListValCATIxPDMItem_var&,CATLISTV(CATBaseUnknown_var)&)
Returns all children of the item with their pointing instance.
o LoadChildForPropertiesEdition(CATBaseUnknown_var&,CATIxPDMItem_var&)
Load a product child to allow properties edition.

Methods


o GetChildrenItems
public virtual HRESULT GetChildrenItems(CATListValCATIxPDMItem_var& oChildrenList,
CATLISTV(CATBaseUnknown_var)& oInstanceChildrenList) = 0
Returns all children of the item with their pointing instance.
Role:This method retrieves all the child items from the current one. You can retrieve instances pointing to missing or not loaded items.
Parameters:
oChildrenList
The children list, those items could be loaded or not. All children are returned, included child pointed through a de-activated instance.
oInstanceChildrenList
The list of pointing instances in Product Structure. The size of this list is always equal to the size of the children list. Pointing instance is returned even for de-activated instances. You can use CATIProduct to navigate on these instances. If an element of oChildrenList is not pointed through a Instance, the corresponding pointer is null.
Returns:
  • S_OK: The children list is successfully computed.
  • E_FAIL: The method has failed. The possible returned errors (listed by their identifier) are:
    • InputERR_1004:
    • Internal error.
o LoadChildForPropertiesEdition
public virtual HRESULT LoadChildForPropertiesEdition( const CATBaseUnknown_var& iInstanceChildToLoad,
CATIxPDMItem_var& oLoadedChild) = 0
Load a product child to allow properties edition.
Role:This method should be used in very specific cases:

Don't forget to Save the modified items after properties edition through CATxPDMSessionServices.SaveSessionToDirectory .

Parameters:
iInstanceChildToLoad
This child instance describes item you want to load, you can retrieve it through
CATIxPDMProductItem.GetChildrenItems .
oLoadedChild
The loaded item, you can use
CATIxPDMItem.GetProperty or CATIxPDMItem.SetProperty .
Returns:
  • S_OK: The item is successfully loaded.
  • E_FAIL: The method has failed. The possible returned errors (listed by their identifier) are:
    • InputERR_1002:
    • Input instance is invalid.
    • InputERR_1004:
    • Internal error.

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

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