All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ENOVInterfaces Interface VPMIWflData

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

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


interface VPMIWflData

Interface of the Workflow Relevant-Data type.
Role: The interface provides functions for accessing and managing Workflow relevant-data.


Method Index


o Destroy()
Destroy the relevant-data.
o Dump(char*)
Dump the relevant-data.
o GetExpression(CATUnicodeString&)
Get the expression if any.
o GetId(CATUnicodeString&)
Get the id of the relevant-data.
o GetName(CATUnicodeString&)
Get the name of the relevant-data.
o GetOrgId(CATUnicodeString&)
Get the name of the organization owning the relevant-data.
o GetRealData(CATBaseUnknown*&)
Get the real-object pointed to by the relevant-data.
o GetRealData(SEQUENCE(octet)&)
Get the real-object pointed to by the relevant-data.
o GetRealName(CATUnicodeString&)
Get the value of the relevant-data if it is of basic type.
o GetStatus(CATUnicodeString&)
Get the current status of the relevant-data.
o GetType(CATUnicodeString&)
Get the type of the relevant-data.
o GetUserId(CATUnicodeString&)
Get the name of the user owning the relevant-data.
o InputToActivities(CATLISTV(VPMIWflActivity_var)&)
Get all the activities which use this relevant-data as input.
o InputToProcesses(CATLISTV(VPMIWflProcess_var)&)
Get all the processes which use this relevant-data as input.
o IsDispatcher()
Check whether this relecvant-data is intended for multi-instance activity.
o IsInputToActivity(VPMIWflActivity_var&)
Check whether or not this relevant-data is used as input to the given activity.
o IsInputToProcess(VPMIWflProcess_var&)
Check whether or not this relevant-data is used as input to the given process.
o IsOutputFromActivity(VPMIWflActivity_var&)
Check whether or not this relevant-data is used as output of the given activity.
o IsOutputFromProcess(VPMIWflProcess_var&)
Check whether or not this relevant-data is used as input of the given process.
o IsUsedInProcess(VPMIWflProcess_var&)
Check whether or not this relevant-data is used in the given process.
o IsaPrimitiveType()
Check whether or not this relevant-data is of basic type.
o OutputFromActivities(CATLISTV(VPMIWflActivity_var)&)
Get all the activities which use this relevant-data as output.
o OutputFromProcesses(CATLISTV(VPMIWflProcess_var)&)
Get all the processes which use this relevant-data as output.
o SetDispatcher(boolean&)
Set this relevant-data as to be distributed to multi-activity instances.
o SetExpression(CATUnicodeString&)
Set an expression for the relevant-data.
o SetId(CATUnicodeString&)
Set the id of the relevant-data.
o SetName(CATUnicodeString&)
Set the name of the relevant-data.
o SetType(CATUnicodeString&)
Set the type of the relevant-data.
o UsedInProcesses(CATLISTV(VPMIWflProcess_var)&)
Get all the processes which use this relevant-data.

Methods


o Destroy
public virtual HRESULT Destroy()=0
Destroy the relevant-data.
Returns:

Legal values: S_OK The operation succeeds. E_FAIL The operation failed.
o Dump
public virtual HRESULT Dump(char* prefix)=0
Dump the relevant-data.
o GetExpression
public virtual HRESULT GetExpression(CATUnicodeString& oExpr)=0
Get the expression if any.
Parameters:
oExpr
o GetId
public virtual HRESULT GetId(CATUnicodeString& oId)=0
Get the id of the relevant-data.
Parameters:
oId
o GetName
public virtual HRESULT GetName(CATUnicodeString& oName)=0
Get the name of the relevant-data.
Parameters:
oName
o GetOrgId
public virtual HRESULT GetOrgId(CATUnicodeString& oOrgId)=0
Get the name of the organization owning the relevant-data.
Parameters:
oOrgId
o GetRealData
public virtual HRESULT GetRealData(CATBaseUnknown*& oData)=0
Get the real-object pointed to by the relevant-data.
o GetRealData
public virtual HRESULT GetRealData(SEQUENCE(octet)& oData)=0
Get the real-object pointed to by the relevant-data.
o GetRealName
public virtual HRESULT GetRealName(CATUnicodeString& oRealName)=0
Get the value of the relevant-data if it is of basic type.
Parameters:
oRealName
o GetStatus
public virtual HRESULT GetStatus(CATUnicodeString& oStatus)=0
Get the current status of the relevant-data.
Parameters:
oStatus
o GetType
public virtual HRESULT GetType(CATUnicodeString& oType)=0
Get the type of the relevant-data.
Parameters:
oType
o GetUserId
public virtual HRESULT GetUserId(CATUnicodeString& oUserId)=0
Get the name of the user owning the relevant-data.
Parameters:
oUserId
o InputToActivities
public virtual HRESULT InputToActivities(CATLISTV(VPMIWflActivity_var)& oActList)=0
Get all the activities which use this relevant-data as input.
Parameters:
oActList
o InputToProcesses
public virtual HRESULT InputToProcesses(CATLISTV(VPMIWflProcess_var)& oProcessList)=0
Get all the processes which use this relevant-data as input.
Parameters:
oProcessList
o IsDispatcher
public virtual boolean IsDispatcher()=0
Check whether this relecvant-data is intended for multi-instance activity.
Returns:
TRUE If the relevant-data is to be distributed. FALSE Otherwise.
o IsInputToActivity
public virtual boolean IsInputToActivity( const VPMIWflActivity_var& iActivity)=0
Check whether or not this relevant-data is used as input to the given activity.
o IsInputToProcess
public virtual boolean IsInputToProcess( const VPMIWflProcess_var& iProcess)=0
Check whether or not this relevant-data is used as input to the given process.
o IsOutputFromActivity
public virtual boolean IsOutputFromActivity( const VPMIWflActivity_var& iActivity)=0
Check whether or not this relevant-data is used as output of the given activity.
o IsOutputFromProcess
public virtual boolean IsOutputFromProcess( const VPMIWflProcess_var& iProcess)=0
Check whether or not this relevant-data is used as input of the given process.
o IsUsedInProcess
public virtual boolean IsUsedInProcess( const VPMIWflProcess_var& iProcess)=0
Check whether or not this relevant-data is used in the given process.
o IsaPrimitiveType
public virtual HRESULT IsaPrimitiveType()=0
Check whether or not this relevant-data is of basic type.
o OutputFromActivities
public virtual HRESULT OutputFromActivities(CATLISTV(VPMIWflActivity_var)& oActList)=0
Get all the activities which use this relevant-data as output.
Parameters:
oActList
o OutputFromProcesses
public virtual HRESULT OutputFromProcesses(CATLISTV(VPMIWflProcess_var)& oProcessList)=0
Get all the processes which use this relevant-data as output.
Parameters:
oProcessList
o SetDispatcher
public virtual HRESULT SetDispatcher( const boolean& iBool)=0
Set this relevant-data as to be distributed to multi-activity instances.
Parameters:
iBool
o SetExpression
public virtual HRESULT SetExpression( const CATUnicodeString& iExpr)=0
Set an expression for the relevant-data.
Parameters:
iExpr
o SetId
public virtual HRESULT SetId( const CATUnicodeString& iId)=0
Set the id of the relevant-data.
Parameters:
iId
o SetName
public virtual HRESULT SetName( const CATUnicodeString& iName)=0
Set the name of the relevant-data.
Parameters:
iName
o SetType
public virtual HRESULT SetType( const CATUnicodeString& iType)=0
Set the type of the relevant-data.
Parameters:
iType
o UsedInProcesses
public virtual HRESULT UsedInProcesses(CATLISTV(VPMIWflProcess_var)& oProcessList)=0
Get all the processes which use this relevant-data.
Parameters:
oProcessList

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

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