All Frameworks Class Hierarchy This Framework Previous Next Indexes
ENOVInterfaces Interface VPMIWflProcess
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---VPMIWflProcess
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface VPMIWflProcess
Interface of the process type.
Role: The interface provides functions for accessing and managing processes.
Method Index
- o
Abort()
- Abort the process instance.
- o
Bypass()
- Bypass the process instance.
- o
Complete()
- Complete the process instance.
- o
Destroy(int&)
- Destroy the process instance.
- o
Dump(char*)
- Dump the process information.
- o
FindActivityByName(CATUnicodeString&,VPMIWflActivity_var&)
- Search for an activity by name and pertaining to this process.
- o
FindRelevantDataByNames(CATLISTV(CATUnicodeString)&,CATLISTV(VPMIWflData_var)&)
- Search for relevant-data by names and pertaining to this process.
- o
GetActualEndDate(CATTime&)
- Get the planned end date of this process.
- o
GetActualStartDate(CATTime&)
- Get the actual start date of this process.
- o
GetAllActivities(CATLISTV(VPMIWflActivity_var)&)
- Get all activities defined in this process.
- o
GetAllApplications(CATLISTV(VPMIWflApplication_var)&)
- Get all appalications defined in this process.
- o
GetAllInParameters(CATLISTV(CATUnicodeString)&)
- Get all input parameters.
- o
GetAllOutParameters(CATLISTV(CATUnicodeString)&)
- Get all output parameters.
- o
GetAllParticipants(CATLISTV(VPMIWflParticipant_var)&)
- Get all participants defined in this process.
- o
GetAllRelevantData(CATLISTV(VPMIWflData_var)&)
- Get all relevant-data defined in this process.
- o
GetAllTransitions(CATLISTV(VPMIWflTransition_var)&)
- Get all transitions defined in this process.
- o
GetClassification(CATUnicodeString&)
- Get the classification.
- o
GetCost(CATUnicodeString&)
- Get the cost estimated for this process.
- o
GetDefinitionName(CATUnicodeString&)
- Get the name of the Workflow definition mmodel.
- o
GetDelinquencyDate(CATTime&)
- Get the delinquency date of this process.
- o
GetDelinquencyInt(long&)
- Get the delinquency interval of this process.
- o
GetDocumentation(CATUnicodeString&)
- Get the documentation reference.
- o
GetDuration(long&)
- Get the planned duration of this process.
- o
GetEndDate(CATTime&)
- Get the planned end date of this process.
- o
GetEntryCondition(CATUnicodeString&)
- Get the entry condition.
- o
GetExitCode(long&)
- Get the exit code.
- o
GetExitCondition(CATUnicodeString&)
- Get the exit condition.
- o
GetFinishMode(CATUnicodeString&)
- Get the finish mode of this process.
- o
GetId(CATUnicodeString&)
- Get the process id.
- o
GetName(CATUnicodeString&)
- Get the process name.
- o
GetPrimaryObject(CATUnicodeString&)
- Get the id of the primary object.
- o
GetRealResponsible(CATIVpmPEPerson_var&)
- Get the actual user who is the responsible (owner) of the process.
- o
GetResourceCtxt(CATUnicodeString&)
- Get the resource context of this process.
- o
GetResponsible(VPMIWflParticipant_var&)
- Get the participant (responsible) associated with the process.
- o
GetStartDate(CATTime&)
- Get the planned start date of this process.
- o
GetStartMode(CATUnicodeString&)
- Get the start mode of this process.
- o
GetStatus(CATUnicodeString&)
- Get the current status.
- o
GetValidFrom(CATTime&)
- Get the start date of validity.
- o
GetValidTo(CATTime&)
- Get the end date of validity.
- o
GetVersion(CATUnicodeString&)
- Get the version.
- o
GetWaitTime(double&)
- Get the planned wait time of the process.
- o
GetWaitingTime(long&)
- Get the waiting time of this process.
- o
IsAutoFinish()
- Check whether or not the completion mode of this process is automatic.
- o
IsAutoStart()
- Check whether or not the start mode of this process is automatic.
- o
Launch(CATLISTV(CATBaseUnknown_var)&,CATLISTV(CATUnicodeString)&,CATUnicodeString&)
- Launch the process instance by feeding it with the required data and
optionally, specifying the name of its responsible.
- o
Prepare(CATLISTV(CATBaseUnknown_var)&,CATLISTV(CATUnicodeString)&,CATUnicodeString&)
- Prepare the process instance by giving it its required data and
optionally the responsible id and role.
- o
Reinitialize()
- Reinitialize the process instance.
- o
Resume()
- Resume the process instance.
- o
SetId(CATUnicodeString&)
- Set the process id.
- o
SetName(CATUnicodeString&)
- Set the process name.
- o
SetResponsibleByName(CATUnicodeString&,CATUnicodeString&)
- Update the process responsible by specifying a user name and potenbtially its role.
- o
Start()
- Start the process instance.
- o
Suspend()
- Suspend the process instance.
Methods
o Abort
-
Abort the process instance.
- Returns:
-
Legal values:
S_OK The operation succeeds. As consequence the process state
will move to state Aborted.
E_FAIL The operation failed.
o Bypass
-
Bypass the process instance.
- Returns:
-
Legal values:
S_OK The operation succeeds. As consequence the process state
will move to state Bypassed.
E_FAIL The operation failed.
o Complete
public virtual HRESULT Complete( | )= 0 |
-
Complete the process instance.
- Returns:
-
Legal values:
S_OK The operation succeeds. As consequence the process state
will move to state Completed.
E_FAIL The operation failed.
o Destroy
public virtual HRESULT Destroy( | const int& | iFlag | =0)=0 |
-
Destroy the process instance.
- Parameters:
-
- iFlag
- Optional parameter to specify if referenced components have to be destroyed too.
Legal values:
0 Do not destroy components (default).
1 Destroy components.
- Returns:
-
Legal values:
S_OK The operation succeeds.
E_FAIL The operation failed.
o Dump
public virtual HRESULT Dump( | char* | iTag)=0 |
-
Dump the process information.
- Parameters:
-
- iTag
o FindActivityByName
-
Search for an activity by name and pertaining to this process.
- Parameters:
-
- iActName
-
- oActivi
-
- Returns:
- S_OK An activity is found with the name specified
E_FAIL No activity was found
o FindRelevantDataByNames
public virtual HRESULT FindRelevantDataByNames( | const CATLISTV(CATUnicodeString)& | iDataNames, |
| CATLISTV(VPMIWflData_var)& | oListData)=0 |
-
Search for relevant-data by names and pertaining to this process.
- Parameters:
-
- iDataNames
-
- oListData
-
- Returns:
- S_OK An activity is found with the name specified
E_FAIL At least one relevant-data is not found
o GetActualEndDate
-
Get the planned end date of this process.
- Parameters:
-
- oDate
o GetActualStartDate
-
Get the actual start date of this process.
- Parameters:
-
- oDate
o GetAllActivities
public virtual HRESULT GetAllActivities( | CATLISTV(VPMIWflActivity_var)& | oListOfActivities)=0 |
-
Get all activities defined in this process.
- Parameters:
-
- oListOfActivities
o GetAllApplications
public virtual HRESULT GetAllApplications( | CATLISTV(VPMIWflApplication_var)& | oApplicationList)=0 |
-
Get all appalications defined in this process.
- Parameters:
-
- oApplicationList
o GetAllInParameters
public virtual HRESULT GetAllInParameters( | CATLISTV(CATUnicodeString)& | oInParameterList)=0 |
-
Get all input parameters.
- Parameters:
-
- oInParameterList
o GetAllOutParameters
public virtual HRESULT GetAllOutParameters( | CATLISTV(CATUnicodeString)& | oOutParameterList)=0 |
-
Get all output parameters.
- Parameters:
-
- oOutParameterList
o GetAllParticipants
public virtual HRESULT GetAllParticipants( | CATLISTV(VPMIWflParticipant_var)& | oParticipantList)=0 |
-
Get all participants defined in this process.
- Parameters:
-
- oParticipantList
o GetAllRelevantData
public virtual HRESULT GetAllRelevantData( | CATLISTV(VPMIWflData_var)& | oRelevantDataList)=0 |
-
Get all relevant-data defined in this process.
- Parameters:
-
- oRelevantDataList
o GetAllTransitions
public virtual HRESULT GetAllTransitions( | CATLISTV(VPMIWflTransition_var)& | oTransitionList)=0 |
-
Get all transitions defined in this process.
- Parameters:
-
- oTransitionList
o GetClassification
-
Get the classification.
- Parameters:
-
- oClassification
o GetCost
-
Get the cost estimated for this process.
- Parameters:
-
- oCost
o GetDefinitionName
-
Get the name of the Workflow definition mmodel.
- Parameters:
-
- oDefName
o GetDelinquencyDate
-
Get the delinquency date of this process.
- Parameters:
-
- oDate
o GetDelinquencyInt
public virtual HRESULT GetDelinquencyInt( | long& | oDelInt)=0 |
-
Get the delinquency interval of this process.
- Parameters:
-
- oDelInt
o GetDocumentation
-
Get the documentation reference.
- Parameters:
-
- oCond
o GetDuration
public virtual HRESULT GetDuration( | long& | oDuration)=0 |
-
Get the planned duration of this process.
- Parameters:
-
- oDuration
o GetEndDate
-
Get the planned end date of this process.
- Parameters:
-
- oDate
o GetEntryCondition
-
Get the entry condition.
- Parameters:
-
- oCond
o GetExitCode
public virtual HRESULT GetExitCode( | long& | oExitCode)=0 |
-
Get the exit code.
- Parameters:
-
- oExitCode
o GetExitCondition
-
Get the exit condition.
- Parameters:
-
- oCond
o GetFinishMode
-
Get the finish mode of this process.
- Parameters:
-
- oFinishMode
-
Legal values:
MANUAL
AUTO
o GetId
-
Get the process id.
- Parameters:
-
- oId
o GetName
-
Get the process name.
- Parameters:
-
- iName
o GetPrimaryObject
-
Get the id of the primary object.
- Parameters:
-
- oPrimObjId
o GetRealResponsible
public virtual HRESULT GetRealResponsible( | CATIVpmPEPerson_var& | oPerson)=0 |
-
Get the actual user who is the responsible (owner) of the process.
- Parameters:
-
- oPerson
o GetResourceCtxt
-
Get the resource context of this process.
- Parameters:
-
- oResCtxt
o GetResponsible
public virtual HRESULT GetResponsible( | VPMIWflParticipant_var& | oResponsible)=0 |
-
Get the participant (responsible) associated with the process.
- Parameters:
-
- oResponsible
o GetStartDate
-
Get the planned start date of this process.
- Parameters:
-
- oDate
o GetStartMode
-
Get the start mode of this process.
- Parameters:
-
- oStartMode
-
Legal values:
MANUAL
AUTO
o GetStatus
-
Get the current status.
- Parameters:
-
- oStatus
o GetValidFrom
-
Get the start date of validity.
- Parameters:
-
- oDate
o GetValidTo
-
Get the end date of validity.
- Parameters:
-
- oDate
o GetVersion
-
Get the version.
- Parameters:
-
- oVersion
o GetWaitTime
public virtual HRESULT GetWaitTime( | double& | oWaitTime)=0 |
-
Get the planned wait time of the process.
- Parameters:
-
- oWaitTime
o GetWaitingTime
public virtual HRESULT GetWaitingTime( | long& | oWaitingTime)=0 |
-
Get the waiting time of this process.
- Parameters:
-
- oDate
o IsAutoFinish
public virtual boolean IsAutoFinish( | )=0 |
-
Check whether or not the completion mode of this process is automatic.
- Returns:
- TRUE The process is to be completed automatically.
FALSE The process is to be completed manually.
o IsAutoStart
public virtual boolean IsAutoStart( | )=0 |
-
Check whether or not the start mode of this process is automatic.
- Returns:
- TRUE The process is to be started automatically.
FALSE The process is to be started manually.
o Launch
-
Launch the process instance by feeding it with the required data and
optionally, specifying the name of its responsible. Actually, this function
calls Prepare() and then Start().
- Parameters:
-
- iListObjData
-
- iListPrimData
-
- iResId
- Optional. The Id of the user who will be owner of the process.
If not spcified, the owner is the one specified in the process participant.
- Returns:
-
Legal values:
S_OK The operation succeeds. As consequence the process state
will move to state Running.
E_FAIL The operation failed.
o Prepare
-
Prepare the process instance by giving it its required data and
optionally the responsible id and role.
- Parameters:
-
- iListObjData
-
- iListPrimData
-
- iResId
- Optional. The Id of the user who will be owner of the process.
If not spcified, the owner is the one specified in the process participant.
- Returns:
-
Legal values:
S_OK The operation succeeds. As consequence the process state
will move to state Ready.
E_FAIL The operation failed.
o Reinitialize
public virtual HRESULT Reinitialize( | )= 0 |
-
Reinitialize the process instance.
- Returns:
-
Legal values:
S_OK The operation succeeds. As consequence the process state
will move to state Created.
E_FAIL The operation failed.
o Resume
-
Resume the process instance.
- Returns:
-
Legal values:
S_OK The operation succeeds. As consequence the process state
will move back to state Running.
E_FAIL The operation failed.
o SetId
-
Set the process id.
- Parameters:
-
- iId
o SetName
-
Set the process name.
- Parameters:
-
- oName
o SetResponsibleByName
-
Update the process responsible by specifying a user name and potenbtially its role.
A participant must be defined and associated with the process.
- Parameters:
-
- iRespName
-
- iRespRoleId
- Optional.
o Start
-
Start the process instance.
- Returns:
-
Legal values:
S_OK The operation succeeds. As consequence the process state
will move to state Running.
E_FAIL The operation failed.
o Suspend
public virtual HRESULT Suspend( | )= 0 |
-
Suspend the process instance.
A call to Resume() will restart the process.
- Returns:
-
Legal values:
S_OK The operation succeeds. As consequence the process state
will move to state Suspended.
E_FAIL The operation failed.
This object is included in the file: VPMIWflProcess.h
If needed, your Imakefile.mk should include the module: GUIDENOVInterfaces