All Frameworks Class Hierarchy This Framework Previous Next Indexes
ENOVInterfaces Interface VPMIWflActivity
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---VPMIWflActivity
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface VPMIWflActivity
Interface of the root activity type.
Role: The interface provides functions for accessing and managing basic activities.
Method Index
- o
Abort()
- Abort the activity instance.
- o
Bypass()
- Bypass the activity instance.
- o
Complete()
- Complete the activity instance.
- o
Destroy(int&)
- Destroy the activity instance.
- o
Dump(char*)
- Dump the activity data.
- o
GetActualEndDate(CATTime&)
- Get the planned end date of the activity.
- o
GetActualStartDate(CATTime&)
- Get the actual start date of the activity.
- o
GetAllExpectedInputs(CATLISTV(CATUnicodeString)&)
- Get all expected inputs names.
- o
GetAllExpectedOutputs(CATLISTV(CATUnicodeString)&)
- Get all expected outputs names.
- o
GetDelinquencyDate(CATTime&)
- Get the delinquency date of the activity.
- o
GetDelinquencyInt(long&)
- Get the delinquency interval of the activity.
- o
GetDocumentation(CATUnicodeString&)
- Get the documentation reference.
- o
GetDuration(long&)
- Get the planned duration of the activity.
- o
GetEndDate(CATTime&)
- Get the planned end date of the activity.
- o
GetEntryCondition(CATUnicodeString&)
- Get the entry condition.
- o
GetExitCode(long&)
- Get the exit code.
- o
GetExitCondition(CATUnicodeString&)
- Get the exit condition.
- o
GetId(CATUnicodeString&)
- Get the activity id.
- o
GetName(CATUnicodeString&)
- Get the activity name.
- o
GetNextWorkingTransitions(CATLISTV(CATUnicodeString)&)
- Get the list of all next transitions terminals of attached working lifecycle.
- o
GetParentProcess(VPMIWflProcess_var&)
- Get the parent process of the activity.
- o
GetStartDate(CATTime&)
- Get the planned start date of the activity.
- o
GetStatus(CATUnicodeString&)
- Get the current status of the activity.
- o
GetWaitTime(double&)
- Get the planned wait time of the activity.
- o
GetWorkingLCycleName(CATUnicodeString&)
- Get the name of the working lifecycle attached to the activity.
- o
GetWorkingStatus(CATUnicodeString&)
- Get the current working status.
- o
IsWorkingStatusFinal()
- Check if the current working status of the activity is final or not.
- o
Power()
- Powers the activity instance.
- o
Prepare()
- Prepare the activity instance.
- o
Reinitialize()
- Reinitialize the activity instance.
- o
Resume()
- Resume the activity instance.
- o
SetId(CATUnicodeString&)
- Set the activity id.
- o
SetName(CATUnicodeString&)
- Set the activity name.
- o
Start()
- Start the activity instance.
- o
Suspend()
- Suspend the activity instance.
Methods
o Abort
-
Abort the activity instance.
- Returns:
-
Legal values:
S_OK The operation succeeds. As consequence the activity state
will move to state Aborted.
E_FAIL The operation failed.
o Bypass
-
Bypass the activity instance.
- Returns:
-
Legal values:
S_OK The operation succeeds. As consequence the activity state
will move to state Bypassed.
E_FAIL The operation failed.
o Complete
public virtual HRESULT Complete( | )= 0 |
-
Complete the activity instance.
- Returns:
-
Legal values:
S_OK The operation succeeds. As consequence the activity state
will move to state Complete.
E_FAIL The operation failed.
o Destroy
public virtual HRESULT Destroy( | const int& | iFlag | =0)=0 |
-
Destroy the activity 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* | prefix)=0 |
-
Dump the activity data.
o GetActualEndDate
-
Get the planned end date of the activity.
- Parameters:
-
- oDate
o GetActualStartDate
-
Get the actual start date of the activity.
- Parameters:
-
- oDate
o GetAllExpectedInputs
public virtual HRESULT GetAllExpectedInputs( | CATLISTV(CATUnicodeString)& | oListData)=0 |
-
Get all expected inputs names.
- Parameters:
-
- oListData
o GetAllExpectedOutputs
public virtual HRESULT GetAllExpectedOutputs( | CATLISTV(CATUnicodeString)& | oListData)=0 |
-
Get all expected outputs names.
- Parameters:
-
- oListData
o GetDelinquencyDate
-
Get the delinquency date of the activity.
- Parameters:
-
- oDate
o GetDelinquencyInt
public virtual HRESULT GetDelinquencyInt( | long& | oDelInt)=0 |
-
Get the delinquency interval of the activity.
- Parameters:
-
- oDelInt
o GetDocumentation
-
Get the documentation reference.
- Parameters:
-
- oDoc
o GetDuration
public virtual HRESULT GetDuration( | long& | oDuration)=0 |
-
Get the planned duration of the activity.
- Parameters:
-
- oDuration
o GetEndDate
-
Get the planned end date of the activity.
- Parameters:
-
- oDate
o GetEntryCondition
-
Get the entry condition.
- Parameters:
-
- oCond
o GetExitCode
public virtual HRESULT GetExitCode( | long& | oExitCode)=0 |
-
Get the exit code.
- Parameters:
-
- oCond
o GetExitCondition
-
Get the exit condition.
- Parameters:
-
- oCond
o GetId
-
Get the activity id.
- Parameters:
-
- oId
o GetName
-
Get the activity name.
- Parameters:
-
- oName
o GetNextWorkingTransitions
public virtual HRESULT GetNextWorkingTransitions( | CATLISTV(CATUnicodeString)& | oListOfTerminals)=0 |
-
Get the list of all next transitions terminals of attached working lifecycle.
- Parameters:
-
- oListOfTerminals
o GetParentProcess
public virtual HRESULT GetParentProcess( | VPMIWflProcess_var& | oProcess)=0 |
-
Get the parent process of the activity.
- Parameters:
-
- oProcess
o GetStartDate
-
Get the planned start date of the activity.
- Parameters:
-
- oDate
o GetStatus
-
Get the current status of the activity.
- Parameters:
-
- oStatus
o GetWaitTime
public virtual HRESULT GetWaitTime( | double& | oWaitTime)=0 |
-
Get the planned wait time of the activity.
- Parameters:
-
- oDuration
o GetWorkingLCycleName
-
Get the name of the working lifecycle attached to the activity.
- Parameters:
-
- oGraphName
o GetWorkingStatus
-
Get the current working status.
- Parameters:
-
- oStatus
o IsWorkingStatusFinal
public virtual HRESULT IsWorkingStatusFinal( | )=0 |
-
Check if the current working status of the activity is final or not.
- Returns:
- S_OK The status is final
S_FALSE Otherwise
o Power
-
Powers the activity instance.
Normally, this function is called when all CF tokens are received.
- Returns:
-
Legal values:
S_OK The operation succeeds. As consequence the activity state
will move to state Powered.
E_FAIL The operation failed.
o Prepare
public virtual HRESULT Prepare( | )= 0 |
-
Prepare the activity instance.
- Returns:
-
Legal values:
S_OK The operation succeeds. As consequence the activity state
will move to state Ready.
E_FAIL The operation failed.
o Reinitialize
public virtual HRESULT Reinitialize( | )= 0 |
-
Reinitialize the activity instance.
- Returns:
-
Legal values:
S_OK The operation succeeds. As consequence the activity state
will move back to state Created.
E_FAIL The operation failed.
o Resume
-
Resume the activity instance.
- Returns:
-
Legal values:
S_OK The operation succeeds. As consequence the activity state
will move back to state Running.
E_FAIL The operation failed.
o SetId
-
Set the activity id.
- Parameters:
-
- iId
o SetName
-
Set the activity name.
- Parameters:
-
- iName
o Start
-
Start the activity instance.
- Returns:
-
Legal values:
S_OK The operation succeeds. As consequence the activity state
will move to state Running.
E_FAIL The operation failed.
o Suspend
public virtual HRESULT Suspend( | )= 0 |
-
Suspend the activity instance.
- Returns:
- A call to Resume() will restart the activity.
Legal values:
S_OK The operation succeeds. As consequence the activity state
will move to state Suspended.
E_FAIL The operation failed.
This object is included in the file: VPMIWflActivity.h
If needed, your Imakefile.mk should include the module: GUIDENOVInterfaces