All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

VPMDesktopObjects Interface CATIVPMVDAModify

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

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


interface CATIVPMVDAModify

Interface to define the command to modify values of attributes of existing Business Object.
Role : When a Business Object exists, this command hides all the mechanism of changing the values of the object, and provides a way to access to the data by user-exit.


Method Index


o get_Object(ENOVIABusinessObject*&)
Access to the Business Object for which the values of the attributes will change.
o get_Value(CATListOfCATUnicodeString*&,_SEQUENCE_CORBAAny*&)
Access to the list of attribute names to change and their new values.
o put_Object(ENOVIABusinessObject*)
Sets the Business Object for which the values of attributes will change.
o put_Value(CATListOfCATUnicodeString&,_SEQUENCE_CORBAAny&)
Sets the list of attributes to change, with their names and their new values.

Methods


o get_Object
public virtual HRESULT get_Object(ENOVIABusinessObject*& oObject)= 0
Access to the Business Object for which the values of the attributes will change. It is designed for user-exit purposes and should not be used in another context.
Parameters:
oObject
Business Object to modify.
Returns:
Always S_OK.
o get_Value
public virtual HRESULT get_Value(CATListOfCATUnicodeString*& iAttributeNames,
_SEQUENCE_CORBAAny*& oListOfValues)= 0
Access to the list of attribute names to change and their new values. It is designed for user-exit purposes and should not be used in another context.
Parameters:
iAttributeNames
List of attribute names to modify.
oListOfValues
List of the corresponding new values to set.
Returns:
Always S_OK.
o put_Object
public virtual HRESULT put_Object(ENOVIABusinessObject* iObject)= 0
Sets the Business Object for which the values of attributes will change.
Parameters:
iObject
The Business Object to modify.
Returns:
Always S_OK.
o put_Value
public virtual HRESULT put_Value( const CATListOfCATUnicodeString& iAttributeNames,
const _SEQUENCE_CORBAAny& iListOfValues)= 0
Sets the list of attributes to change, with their names and their new values.
Parameters:
iAttributeNames
List of attribute names to change.
iListOfValues
List of corresponding values (same order as the attribute names).
Returns:
Always S_OK, but if the two lists have not the same length, the command will not be executable.

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

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