All Frameworks  Class Hierarchy  This Framework  Indexes   

ENOVInterfaces Interface 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
public virtual 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
public virtual 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 Complete()
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 Destroy( const iFlag=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 Dump( prefix)
Dump the activity data.
o GetActualEndDate
public virtual GetActualEndDate( oDate)
Get the planned end date of the activity.
Parameters:
oDate
o GetActualStartDate
public virtual GetActualStartDate( oDate)
Get the actual start date of the activity.
Parameters:
oDate
o GetAllExpectedInputs
public virtual GetAllExpectedInputs( oListData)
Get all expected inputs names.
Parameters:
oListData
o GetAllExpectedOutputs
public virtual GetAllExpectedOutputs( oListData)
Get all expected outputs names.
Parameters:
oListData
o GetDelinquencyDate
public virtual GetDelinquencyDate( oDate)
Get the delinquency date of the activity.
Parameters:
oDate
o GetDelinquencyInt
public virtual GetDelinquencyInt( oDelInt)
Get the delinquency interval of the activity.
Parameters:
oDelInt
o GetDocumentation
public virtual GetDocumentation( oDoc)
Get the documentation reference.
Parameters:
oDoc
o GetDuration
public virtual GetDuration( oDuration)
Get the planned duration of the activity.
Parameters:
oDuration
o GetEndDate
public virtual GetEndDate( oDate)
Get the planned end date of the activity.
Parameters:
oDate
o GetEntryCondition
public virtual GetEntryCondition( oCond)
Get the entry condition.
Parameters:
oCond
o GetExitCode
public virtual GetExitCode( oExitCode)
Get the exit code.
Parameters:
oCond
o GetExitCondition
public virtual GetExitCondition( oCond)
Get the exit condition.
Parameters:
oCond
o GetId
public virtual GetId( oId)
Get the activity id.
Parameters:
oId
o GetName
public virtual GetName( oName)
Get the activity name.
Parameters:
oName
o GetNextWorkingTransitions
public virtual GetNextWorkingTransitions( oListOfTerminals)
Get the list of all next transitions terminals of attached working lifecycle.
Parameters:
oListOfTerminals
o GetParentProcess
public virtual GetParentProcess( oProcess)
Get the parent process of the activity.
Parameters:
oProcess
o GetStartDate
public virtual GetStartDate( oDate)
Get the planned start date of the activity.
Parameters:
oDate
o GetStatus
public virtual GetStatus( oStatus)
Get the current status of the activity.
Parameters:
oStatus
o GetWaitTime
public virtual GetWaitTime( oWaitTime)
Get the planned wait time of the activity.
Parameters:
oDuration
o GetWorkingLCycleName
public virtual GetWorkingLCycleName( oGraphName)
Get the name of the working lifecycle attached to the activity.
Parameters:
oGraphName
o GetWorkingStatus
public virtual GetWorkingStatus( oStatus)
Get the current working status.
Parameters:
oStatus
o IsWorkingStatusFinal
public virtual IsWorkingStatusFinal()
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
public virtual 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 Prepare()
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 Reinitialize()
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
public virtual 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
public virtual SetId( const iId)
Set the activity id.
Parameters:
iId
o SetName
public virtual SetName( const iName)
Set the activity name.
Parameters:
iName
o Start
public virtual 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 Suspend()
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

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