All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

VPMXBom Interface ENOVICommand

System.IUnknown
  |
  +---VPMXBom.ENOVIBase
    |
    +---ENOVICommand
 

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


interface ENOVICommand


Deprecated:
V5R15 Interface representing a command. Role: This interface is used to implement a standard protocol for all high level command. It works in conjunction with the ENOVICustomCommand to provide a common way for the customer to customize any ENOVIA command. This interface is also there to provide a common passing point for all actions which have an impact on persistent data. This allows us to simplify our transaction processing. Commands are considered to be a special type of objects where the attributes are actually parameters to the command. As such the ENOVICommand derives derives from the ENOVIBase interface.
Customization: For each type of command a late type is defined. To customize a given type of command, the ENOVICustomCommand interface should be implemented in an extension of the corresponding late type.
Design Pattern: the ENOVICommand interface is used to implement the Action/Command design pattern.
Usage Notes: The init, check and execute method should succeed in sequence. If one of those methods is called before the preceding has succeeded, it will fail and will not do anything


Method Index


o Check()
o Execute()
o Init()
o get_IsEnabled(boolean*)
o get_Result(CATIUnknownList**)
o get_Source(CATIUnknownList**)
o set_Source(CATIUnknownList*)

Methods


o Check
public virtual HRESULT __stdcall Check()=0
Deprecated:
V5R15 Checks if the parameters are legal.
Role: When this method gets called the command parameters are checked and the corresponding user exit methods ENOVICustomCommand.BeforeCheck and ENOVICustomCommand.AfterCheck are called. Whenever a parameter marked as sensitive ENOVIAttributeDefinition.get_IsSensitive is modified, this method will be called by the EFC framework. This method call cannot succeed if the init call didn't succeed earlier.
Returns:
An HRESULT value
Legal values:
S_OK
All went well
E_???
something went wrong
o Execute
public virtual HRESULT __stdcall Execute()=0
Deprecated:
V5R15 Executes the command.
Role: When this method gets called the command is executed. The corresponding user exit methods ENOVICustomCommand.BeforeExecute and ENOVICustomCommand.AfterExectute are called. This method call cannot succeed if the check call didn't succeed earlier.
Returns:
An HRESULT value
Legal values:
S_OK
All went well.
E_???
something went wrong
o Init
public virtual HRESULT __stdcall Init()=0
Deprecated:
V5R15 Initializes the command.
Role: When this method gets called the command is initialized and the corresponding user exit methods ENOVICustomCommand.BeforeInit and ENOVICustomCommand.AfterInit are called
Returns:
An HRESULT value
Legal values:
S_OK
All went well
E_???
something went wrong
o get_IsEnabled
public virtual HRESULT __stdcall get_IsEnabled(boolean* oIsEnabled)=0
Deprecated:
V5R15 Retrieves the enabled flag.
Parameters:
oIsEnabled
the retrieved enabled flag.
Returns:
An HRESULT value
Legal values:
S_OK
All went well and the flag is successfully returned
E_???
something went wrong
o get_Result
public virtual HRESULT __stdcall get_Result(CATIUnknownList** oResultObjects)=0
Deprecated:
V5R15 Retrieve the result objects.
Role: The semantic of the result objects depends on the command's type:
  • for a delete command it is empty.
  • for an update command it is the list of updated objects.
  • for an addTo command it is the list of newly created objects.
  • for a create command it is the list of newly created objects.
  • for a customized command it may have a special semantic for the customization.
The result objects are only available after execution of the command.
Parameters:
oResultObjects
The retrieved results list.
Returns:
An HRESULT value
Legal values:
S_OK
All went well.
E_???
Something went wrong
o get_Source
public virtual HRESULT __stdcall get_Source(CATIUnknownList** oSourceObjects)=0
Deprecated:
V5R15 Retrieves the source objects.
Role: The semantic of the source objects depends on the command's type:
  • for a delete command it is the list of objects to delete.
  • for an update command it is the list of objects to update.
  • for an addTo command it is the list of objects on which to add the newly created object(s).
  • for a create command it doesn't make any sense.
  • for a customized command it may have a special semantic for the customization.
Parameters:
oSourceObjects
The retrieved source objects.
Returns:
An HRESULT value
Legal values:
S_OK
All went well.
E_???
something went wrong
o set_Source
public virtual HRESULT __stdcall set_Source(CATIUnknownList* iSourceObjects)=0
Deprecated:
V5R15 Sets the source objects.
Parameters:
iSourceObjects
The new source objects list.
Returns:
An HRESULT value
Legal values:
S_OK
All went well.
E_???
something went wrong
See also:
get_Source

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

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