All Frameworks  Class Hierarchy  This Framework  Next  Indexes

VPMDesktopObjects Interface CATIAVPMVDAAddChild

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

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


interface CATIAVPMVDAAddChild

Interface to the command to add a child to a parent Business Object.
Role: This interface is implemented by Business Objects. It is designed for creating all kinds of Business Objects and attaching them to their parents using a link. Some objects must have a parent and must be created using this interface. Some others can be orphans and must be created using the CATIAVPMVDACreate interface.


Method Index


o get_ChildBObject(ENOVIABusinessObject*&)
Retrieves the newly created Business Object.
o get_ChildData(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,ENOVIABusinessObject*&)
Retrieves the parameters required to create the Business Object.
o get_ChildData(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,ENOVIABusinessObject*&)
o get_ParentBObject(ENOVIABusinessObject*&)
Retrieves the parent of the Business Object to create.
o put_ChildData(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,ENOVIABusinessObject*)
Sets the parameters required to create the new Business Object.
o put_ChildData(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,ENOVIABusinessObject*)
o put_ParentBObject(ENOVIABusinessObject*)
Sets the parent of the new Business Object to create.

Methods


o get_ChildBObject
public virtual HRESULT get_ChildBObject(ENOVIABusinessObject*& oBObject)=0
Retrieves the newly created Business Object.
Parameters:
oBObject
The newly created Business Object
Returns:
Legal values:
S_OK
Success - The Business Object is retrieved
E_FAIL
Failure - The Business Object cannot be retrieved, either because it doesn't exist or because ...
o get_ChildData
public virtual HRESULT get_ChildData(CATUnicodeString& oChildType,
CATUnicodeString& oId,
CATUnicodeString& oName,
CATUnicodeString& oDesc,
CATUnicodeString& oEnvironment,
ENOVIABusinessObject*& oChildRef)=0
Retrieves the parameters required to create the Business Object.
Role: This method is designed for user exit purposes and should not be used in another context.
Parameters:
oChildType
The type of the Business Object to create
oId
The identifier of the Business Object. It must be filled and unique
oName
The name of the Business Object. This name may be blank
oDesc
The description of the Business Object. This description may be blank
oEnvironment
The environment in which the new Business Object is created.
oChildRef
The reference to the Business Object to create
Returns:
Legal values:
S_OK
Success - The parameters of the Business Object to create are retrieved
E_FAIL
Failure - The parameters of the Business Object cannot be retrieved, either because its type or Id is incorrect or because ...
o get_ChildData
public virtual HRESULT get_ChildData(CATUnicodeString& oChildType,
CATUnicodeString& oId,
CATUnicodeString& oName,
CATUnicodeString& oDesc,
ENOVIABusinessObject*& oChildRef)=0
Deprecated:
V5R15 Retrieves the parameters required to create the Business Object.
Role: This method is designed for user exit purposes and should not be used in another context.
Parameters:
oChildType
The type of the Business Object to create
oId
The identifier of the Business Object. It must be filled and unique
oName
The name of the Business Object. This name may be blank
oDesc
The description of the Business Object. This description may be blank
oChildRef
The reference to the Business Object to create
Returns:
Legal values:
S_OK
Success - The parameters of the Business Object to create are retrieved
E_FAIL
Failure - The parameters of the Business Object cannot be retrieved, either because its type or Id is incorrect or because ...
o get_ParentBObject
public virtual HRESULT get_ParentBObject(ENOVIABusinessObject*& oParentBObject)=0
Retrieves the parent of the Business Object to create.
Role: This method is designed for user exit purposes and should not be used in another context.
Parameters:
oParentBObject
The parent of the Business Object to create
Returns:
Legal values:
S_OK
Success - The parent of the Business Object to create is retrieved
E_FAIL
Failure - The parent of the Business Object cannot be retrieved, either because it doesn't exist or because ...
o put_ChildData
public virtual HRESULT put_ChildData( const CATUnicodeString& iChildType,
const CATUnicodeString& iId,
const CATUnicodeString& iName,
const CATUnicodeString& iDesc,
const CATUnicodeString& iEnvironment,
ENOVIABusinessObject* iChildRef)=0
Sets the parameters required to create the new Business Object.
Parameters:
iChildType
The type of the Business Object to create
iId
The identifier of the Business Object.
Legal values: It must be valued (not blank) and unique
iName
The name of the Business Object (optional, may be blank)
iDesc
The description of the Business Object (optional, may be blank)
iEnvironment
The environment in which the object will be created.
iChildRef
The reference to the Business Object to create
Returns:
Legal values:
S_OK
Success - The Business Object can be created
S_FALSE
Success - The Business Object can be created, but its type or its Id is incorrect.
E_FAIL
Failure - The Business Object cannot be created
o put_ChildData
public virtual HRESULT put_ChildData( const CATUnicodeString& iChildType,
const CATUnicodeString& iId,
const CATUnicodeString& iName,
const CATUnicodeString& iDesc,
ENOVIABusinessObject* iChildRef)=0
Deprecated:
V5R15 Sets the parameters required to create the new Business Object.
Parameters:
iChildType
The type of the Business Object to create
iId
The identifier of the Business Object.
Legal values: It must be valued (not blank) and unique
iName
The name of the Business Object (optional, may be blank)
iDesc
The description of the Business Object (optional, may be blank)
iChildRef
The reference to the Business Object to create
Returns:
Legal values:
S_OK
Success - The Business Object can be created
S_FALSE
Success - The Business Object can be created, but its type or its Id is incorrect.
E_FAIL
Failure - The Business Object cannot be created
o put_ParentBObject
public virtual HRESULT put_ParentBObject(ENOVIABusinessObject* iBObject)=0
Sets the parent of the new Business Object to create.
The new Business Object will be attached to this parent.
Parameters:
iBObject
The parent Business Object
Returns:
Always S_OK, even if the parent is passed as a NULL pointer.

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

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