All Categories  Class Hierarchy  This Category  Indexes

Workflow Interface CATIWflUserExit

CATIWflUserExit

Usage: you can reimplement this interface by deriving the supplied VPMWflUEDefault adapter class.

interface CATIWflUserExit

Interface for Workflow Interoperability user exits.
Refer to the delivered code samples VPMWflSmpUE.h and VPMWflSmpUE.cpp for a customized implementation of this interface.

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 virtual int BeforeExpandNode( CATVPMNode* ipvnNodeToExpand)=0

Method called before expanding a given part node.

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 virtual void BeginImport(	const CATUnicodeString&	`iusActId`,
	const CATUnicodeString&	`iusProcId`,
	const CATUnicodeString&	`iusActName`,
	const CATUnicodeString&	`iusProcName`,
	int	`inIter`)=0

Workflow action import beginning.

Parameters:

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

o BuildActionId

public virtual void BuildActionId( CATUnicodeString& ousActionId)=0

Compute action secondary id if required.

Parameters:

ousActionId: Action secondary id.

o ChooseData

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

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

Parameters:

iusDataName: Name of the searched relevant data.
iusDataType: Type of the relevant data.
inObjects: Number of found instances (possibly 0).
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 virtual void EndImport( const CATINEOVpmAFAction_var& ispAction)=0

Workflow action import end.

Parameters:

ispAction: Generated action.

o SelectContext

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

Selection of context for looking for action associated objects.

Parameters:

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

o SelectData

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

Select relevant data to handle.

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: CATIWflUserExit.h
If needed, your Imakefile.mk should include the module: VX0WflInterop