All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ENOVInterfaces Interface VPMIWflApplication

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

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


interface VPMIWflApplication

Interface of the Workflow application type.
Role: The interface provides functions for accessing and managing Workflow applications.


Method Index


o Destroy()
Destroy the application.
o Dump(char*)
Dump the application data.
o GetAllInParameterNames(CATLISTV(CATUnicodeString)&)
Get the list of names of all input parameters.
o GetAllInParameterTypes(CATLISTV(CATUnicodeString)&)
Get the list of types of all input parameters.
o GetAllOutParameterNames(CATLISTV(CATUnicodeString)&)
Get the list of names of all output parameters.
o GetAllOutParameterTypes(CATLISTV(CATUnicodeString)&)
Get the list of types of all output parameters.
o GetDescription(CATUnicodeString&)
Get the description of the application.
o GetId(CATUnicodeString&)
Get the application id.
o GetName(CATUnicodeString&)
Get the application id.
o GetToolName(CATUnicodeString&)
Get the tool name of the application in case the application type is TOOL.
o GetType(CATUnicodeString&)
Get the type of the application.
o IsUsedInProcess(VPMIWflProcess_var&)
Check if this application is used in the process specified in the parameter.
o SetDescription(CATUnicodeString&)
Set the description of the application.
o SetId(CATUnicodeString&)
Set the application id.
o SetName(CATUnicodeString&)
Set the application name.
o UsedInProcesses(CATLISTV(VPMIWflProcess_var)&)
Give the list of processes where this application is used.

Methods


o Destroy
public virtual HRESULT Destroy()=0
Destroy the application.
Returns:

Legal values: S_OK The operation succeeds. E_FAIL The operation failed.
o Dump
public virtual HRESULT Dump(char* prefix)=0
Dump the application data.
o GetAllInParameterNames
public virtual HRESULT GetAllInParameterNames(CATLISTV(CATUnicodeString)& oInParamNameList)=0
Get the list of names of all input parameters.
Parameters:
oInParamNameList
o GetAllInParameterTypes
public virtual HRESULT GetAllInParameterTypes(CATLISTV(CATUnicodeString)& oInParamTypeList)=0
Get the list of types of all input parameters.
Parameters:
oInParamTypeList
o GetAllOutParameterNames
public virtual HRESULT GetAllOutParameterNames(CATLISTV(CATUnicodeString)& oOutParamNameList)=0
Get the list of names of all output parameters.
Parameters:
oOutParamNameList
o GetAllOutParameterTypes
public virtual HRESULT GetAllOutParameterTypes(CATLISTV(CATUnicodeString)& oOutParamTypeList)=0
Get the list of types of all output parameters.
Parameters:
oOutParamTypeList
o GetDescription
public virtual HRESULT GetDescription(CATUnicodeString& oDescription)=0
Get the description of the application.
Parameters:
oDescription
o GetId
public virtual HRESULT GetId(CATUnicodeString& oId)=0
Get the application id.
Parameters:
oId
o GetName
public virtual HRESULT GetName(CATUnicodeString& oName)=0
Get the application id.
Parameters:
oName
o GetToolName
public virtual HRESULT GetToolName(CATUnicodeString& oToolName)=0
Get the tool name of the application in case the application type is TOOL..
Parameters:
oDescription
o GetType
public virtual HRESULT GetType(CATUnicodeString& oType)=0
Get the type of the application.
Parameters:
oType
o IsUsedInProcess
public virtual boolean IsUsedInProcess( const VPMIWflProcess_var& iProcess)=0
Check if this application is used in the process specified in the parameter.
Parameters:
iProcess
Returns:
TRUE is the application is used in the process. FALSE, otherwise.
o SetDescription
public virtual HRESULT SetDescription( const CATUnicodeString& iDescription)=0
Set the description of the application.
Parameters:
iDescription
o SetId
public virtual HRESULT SetId( const CATUnicodeString& iId)=0
Set the application id.
Parameters:
iId
o SetName
public virtual HRESULT SetName( const CATUnicodeString& iName)=0
Set the application name.
Parameters:
iName
o UsedInProcesses
public virtual HRESULT UsedInProcesses(CATLISTV(VPMIWflProcess_var)& oProcessList)=0
Give the list of processes where this application is used.
Parameters:
oProcessList

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

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