All Frameworks Class Hierarchy This Framework Indexes
ENOVInterfaces Interface 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
-
Destroy the participant.
- Returns:
-
Legal values:
S_OK The operation succeeds.
E_FAIL The operation failed.
o Dump
| public virtual Dump( | | prefix) |
-
Dump the participant.
o GetCondition
| public virtual GetCondition( | | oCond) |
-
Get the condition if any.
- Parameters:
-
- oCond
o GetExpression
| public virtual GetExpression( | | oExpr) |
-
Get the expression if any.
- Parameters:
-
- oExpr
o GetId
| public virtual GetId( | | oId) |
-
Get the participant id.
- Parameters:
-
- oId
o GetName
| public virtual GetName( | | oName) |
-
Get the participant name.
- Parameters:
-
- oName
o GetResourceCtxt
| public virtual GetResourceCtxt( | | oResCtxt) |
-
Get the (specific) context of this participant.
- Parameters:
-
- oResCtxt
o GetResourceName
| public virtual GetResourceName( | | oResName) |
-
Get the name of the real resource.
- Parameters:
-
- oResName
o GetType
| public virtual GetType( | | oType) |
-
Get the type of the participant.
- Parameters:
-
- oType
o IsRequiredByActivity
| public virtual IsRequiredByActivity( | const | iActivity) |
-
Check whether or not this participant is required as performer of the given activity.
o IsRequiredInProcess
| public virtual IsRequiredInProcess( | const | iProcess) |
-
Check whether or not this participant is required in the given process.
o IsResolved
| public virtual IsResolved( | ) |
-
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 IsResponsibleOfProcess( | const | iProcess) |
-
Check whether or not this participant is required as responsible of the given process.
o IsShared
| public virtual IsShared( | ) |
-
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 LookupResourceCtxt( | | oResCtxt, |
| const | iProcess | =NULL_var) |
-
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 RequiredByActivities( | | oActivityList) |
-
Get all the activitiess which define this participant as performer.
- Parameters:
-
- oProcessList
o RequiredInProcesses
| public virtual RequiredInProcesses( | | oProcessList) |
-
Get all the processes which require this participant.
- Parameters:
-
- oProcessList
o Resolve
| public virtual Resolve( | const | iInProcess, |
| | oPerson, |
| | oRole, |
| | oOrg) |
-
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 ResponsibleOfProcesses( | | oProcessList) |
-
Get all the processes which define this participant as responsible.
- Parameters:
-
- oProcessList
o SetCondition
| public virtual SetCondition( | const | iCond) |
-
Set a condition for the participant.
- Parameters:
-
- iCond
o SetExpression
| public virtual SetExpression( | const | iExpr) |
-
Set an expression for the participant.
- Parameters:
-
- iExpr
o SetId
| public virtual SetId( | const | iId) |
-
Set the participant id.
- Parameters:
-
- iId
o SetName
| public virtual SetName( | const | iName) |
-
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