All Categories  Class Hierarchy  This Category  Indexes

Workflow Class VPMWflUEDefault

VPMWflUEDefault

Usage: you can derive this class.

public class VPMWflUEDefault

Default implementation of user exits.
A customized implementation for the user exists should derive from this class.
In case the interface evolves : new methods will be recognized without code change (but recompilation may be necessary).

Method Index

o BeforeExpandNode(CATVPMNode*): Method called before expanding a given part node.
o BeginImport(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,int): Workflow action import beginning.
o BuildActionId(CATUnicodeString&): Compute action secondary id if required.
o ChooseData(CATUnicodeString&,CATUnicodeString&,int,ObjID*,ObjID&): Method called after the search for the real data matching a given relevant data name.
o EndImport(CATINEOVpmAFAction_var&): Workflow action import end.
o SelectContext(ObjID&,CATUnicodeString&): Selection of context for looking for action associated objects.
o SelectData(CATListOfCATUnicodeString&,CATListOfCATUnicodeString&,CATListOfCATUnicodeString&,CATListOfCATUnicodeString&): Select relevant data to handle.

Methods

o BeforeExpandNode

public int BeforeExpandNode( CATVPMNode* ipvnNodeToExpand)

Method called before expanding a given part node. This default method always returns TRUE.

Parameters:

ipvnNodeToExpand: Part node that is about to be expanded.

Returns:

TRUE if the node is to be kept.
FALSE if the node is to be ignored.

o BeginImport

public void BeginImport(	const CATUnicodeString&	`iusActId`,
	const CATUnicodeString&	`iusProcId`,
	const CATUnicodeString&	`iusActName`,
	const CATUnicodeString&	`iusProcName`,
	int	`inIter`)

Workflow action import beginning.

Parameters:

iusActId: Activity id.
iusProcId: Process id.
iusActName: Activity name.
iusProcName: Process name.
inIter: Activity iteration number.

o BuildActionId

public void BuildActionId( CATUnicodeString& ousActionId)

Compute action secondary id if required. The secondary id is built as : <processId>_<activityId>_<iterationNum>

Parameters:

ousActionId: Action secondary id.

o ChooseData

public int ChooseData(	const CATUnicodeString&	`iusDataName`,
	const CATUnicodeString&	`iusDataType`,
	int	`inObjects`,
	const ObjID*	`iFoundObjects`,
	ObjID&	`oSelected`)

Method called after the search for the real data matching a given relevant data name.

If inObjects is 0, this default method returns FALSE.
If inObjects is not 0, this method retrieves the latest object from the list (according to the C_LASTMOD attribute) and returns TRUE.

Parameters:

iusDataName: Name of the searched relevant data.
iusDataType: Type of the relevant data.
inObjects: Number of found instances.
iFoundObjects: Array of found instances ids.
oSelected: The id of the instance to select if the method returns TRUE.

Returns:

TRUE if an instance could be selected.
FALSE if the data should be marked as missing.

o EndImport

public void EndImport( const CATINEOVpmAFAction_var& ispAction)

Workflow action import end. This default method does nothing.

Parameters:

ispAction: Generated action.

o SelectContext

public void SelectContext(	ObjID&	`ioProduct`,
	CATUnicodeString&	`iousConfigHandler`)

Selection of context for looking for action associated objects. This default method does nothing.

Parameters:

ioProduct: Product root part id.
iousConfigHandler: Name of the config-handler to use for product expand.

o SelectData

public void SelectData(	const CATListOfCATUnicodeString&	`ilusNames`,
	const CATListOfCATUnicodeString&	`ilusTypes`,
	const CATListOfCATUnicodeString&	`ilusValues`,
	CATListOfCATUnicodeString&	`olusNamesToRemove`)

Select relevant data to handle. This default method does nothing.

Parameters:

ilusNames: List of relevant data names.
ilusTypes: List of relevant data types.
ilusValues: List of relevant data values.
olusNamesToRemove: List of relevant data to ignore during looking for action associated objects.

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