All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ENOVInterfaces Interface VPMIWflParticipant

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

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


interface VPMIWflParticipant

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


Method Index


o Destroy()
Destroy the participant.
o Dump(char*)
Dump the participant.
o GetCondition(CATUnicodeString&)
Get the condition if any.
o GetExpression(CATUnicodeString&)
Get the expression if any.
o GetId(CATUnicodeString&)
Get the participant id.
o GetName(CATUnicodeString&)
Get the participant name.
o GetResourceCtxt(CATUnicodeString&)
Get the (specific) context of this participant.
o GetResourceName(CATUnicodeString&)
Get the name of the real resource.
o GetType(CATUnicodeString&)
Get the type of the participant.
o IsRequiredByActivity(VPMIWflRegularActivity_var&)
Check whether or not this participant is required as performer of the given activity.
o IsRequiredInProcess(VPMIWflProcess_var&)
Check whether or not this participant is required in the given process.
o IsResolved()
Check whether or not this participant is resolved, ie.
o IsResponsibleOfProcess(VPMIWflProcess_var&)
Check whether or not this participant is required as responsible of the given process.
o IsShared()
Check whether or not this participant is required by several processes and/or activities.
o LookupResourceCtxt(CATUnicodeString&,VPMIWflProcess_var&)
Look up for the context defined for this participant.
o RequiredByActivities(CATLISTV(VPMIWflRegularActivity_var)&)
Get all the activitiess which define this participant as performer.
o RequiredInProcesses(CATLISTV(VPMIWflProcess_var)&)
Get all the processes which require this participant.
o Resolve(VPMIWflProcess_var&,CATIVpmPEPerson_var&,CATIVpmPERole_var&,CATIVpmPEOrganization_var&)
Resolve the particpant by looking for a person who matches the participant definition.
o ResponsibleOfProcesses(CATLISTV(VPMIWflProcess_var)&)
Get all the processes which define this participant as responsible.
o SetCondition(CATUnicodeString&)
Set a condition for the participant.
o SetExpression(CATUnicodeString&)
Set an expression for the participant.
o SetId(CATUnicodeString&)
Set the participant id.
o SetName(CATUnicodeString&)
Set the participant name.

Methods


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

Legal values: S_OK The operation succeeds. E_FAIL The operation failed.
o Dump
public virtual HRESULT Dump(char* prefix)=0
Dump the participant.
o GetCondition
public virtual HRESULT GetCondition(CATUnicodeString& oCond)=0
Get the condition if any.
Parameters:
oCond
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 participant id.
Parameters:
oId
o GetName
public virtual HRESULT GetName(CATUnicodeString& oName)=0
Get the participant name.
Parameters:
oName
o GetResourceCtxt
public virtual HRESULT GetResourceCtxt(CATUnicodeString& oResCtxt)=0
Get the (specific) context of this participant.
Parameters:
oResCtxt
o GetResourceName
public virtual HRESULT GetResourceName(CATUnicodeString& oResName)=0
Get the name of the real resource.
Parameters:
oResName
o GetType
public virtual HRESULT GetType(CATUnicodeString& oType)=0
Get the type of the participant.
Parameters:
oType
o IsRequiredByActivity
public virtual boolean IsRequiredByActivity( const VPMIWflRegularActivity_var& iActivity)=0
Check whether or not this participant is required as performer of the given activity.
o IsRequiredInProcess
public virtual boolean IsRequiredInProcess( const VPMIWflProcess_var& iProcess)=0
Check whether or not this participant is required in the given process.
o IsResolved
public virtual boolean IsResolved()=0
Check whether or not this participant is resolved, ie. a person is bound as to be the performer of the associated activity.
Returns:
TRUE If the participant is resolved. FALSE Otherwise
o IsResponsibleOfProcess
public virtual boolean IsResponsibleOfProcess( const VPMIWflProcess_var& iProcess)=0
Check whether or not this participant is required as responsible of the given process.
o IsShared
public virtual boolean IsShared()=0
Check whether or not this participant is required by several processes and/or activities.
Returns:
TRUE If the participant is shared. FALSE Otherwise
o LookupResourceCtxt
public virtual HRESULT LookupResourceCtxt(CATUnicodeString& oResCtxt,
const VPMIWflProcess_var& iProcess=NULL_var)=0
Look up for the context defined for this participant. The context is searched first locally, then in the process, and finally from default settings.
Parameters:
oResCtxt
iProcess
o RequiredByActivities
public virtual HRESULT RequiredByActivities(CATLISTV(VPMIWflRegularActivity_var)& oActivityList)=0
Get all the activitiess which define this participant as performer.
Parameters:
oProcessList
o RequiredInProcesses
public virtual HRESULT RequiredInProcesses(CATLISTV(VPMIWflProcess_var)& oProcessList)=0
Get all the processes which require this participant.
Parameters:
oProcessList
o Resolve
public virtual HRESULT Resolve( const VPMIWflProcess_var& iInProcess,
CATIVpmPEPerson_var& oPerson,
CATIVpmPERole_var& oRole,
CATIVpmPEOrganization_var& oOrg)=0
Resolve the particpant by looking for a person who matches the participant definition.
Parameters:
iInProcess
The process within which the resolution has to be achieved.
oPerson
The P&O person found.
oRole
The role of the selected person.
oOrg
The organization to which the selected person belongs.
o ResponsibleOfProcesses
public virtual HRESULT ResponsibleOfProcesses(CATLISTV(VPMIWflProcess_var)& oProcessList)=0
Get all the processes which define this participant as responsible.
Parameters:
oProcessList
o SetCondition
public virtual HRESULT SetCondition( const CATUnicodeString& iCond)=0
Set a condition for the participant.
Parameters:
iCond
o SetExpression
public virtual HRESULT SetExpression( const CATUnicodeString& iExpr)=0
Set an expression for the participant.
Parameters:
iExpr
o SetId
public virtual HRESULT SetId( const CATUnicodeString& iId)=0
Set the participant id.
Parameters:
iId
o SetName
public virtual HRESULT SetName( const CATUnicodeString& iName)=0
Set the participant name.
Parameters:
iName

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

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