All Frameworks  Class Hierarchy  This Framework  Indexes   

ENOVInterfaces Interface 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 Destroy()
Destroy the application.
Returns:

Legal values: S_OK The operation succeeds. E_FAIL The operation failed.
o Dump
public virtual Dump( prefix)
Dump the application data.
o GetAllInParameterNames
public virtual GetAllInParameterNames( oInParamNameList)
Get the list of names of all input parameters.
Parameters:
oInParamNameList
o GetAllInParameterTypes
public virtual GetAllInParameterTypes( oInParamTypeList)
Get the list of types of all input parameters.
Parameters:
oInParamTypeList
o GetAllOutParameterNames
public virtual GetAllOutParameterNames( oOutParamNameList)
Get the list of names of all output parameters.
Parameters:
oOutParamNameList
o GetAllOutParameterTypes
public virtual GetAllOutParameterTypes( oOutParamTypeList)
Get the list of types of all output parameters.
Parameters:
oOutParamTypeList
o GetDescription
public virtual GetDescription( oDescription)
Get the description of the application.
Parameters:
oDescription
o GetId
public virtual GetId( oId)
Get the application id.
Parameters:
oId
o GetName
public virtual GetName( oName)
Get the application id.
Parameters:
oName
o GetToolName
public virtual GetToolName( oToolName)
Get the tool name of the application in case the application type is TOOL..
Parameters:
oDescription
o GetType
public virtual GetType( oType)
Get the type of the application.
Parameters:
oType
o IsUsedInProcess
public virtual IsUsedInProcess( const iProcess)
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 SetDescription( const iDescription)
Set the description of the application.
Parameters:
iDescription
o SetId
public virtual SetId( const iId)
Set the application id.
Parameters:
iId
o SetName
public virtual SetName( const iName)
Set the application name.
Parameters:
iName
o UsedInProcesses
public virtual UsedInProcesses( oProcessList)
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.