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
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 Execute(
)
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.