All Categories  Class Hierarchy  This Category  Previous  Next  Indexes

ActionFlow Class CATVpmAFExtServices

CATVpmAFExtServices

public class CATVpmAFExtServices

This class regroups a number of static methods to be called by the customer.

Method Index

o GetAction(char*,char**): Get the ID of an Action from its working effectivity
o GetAffectedObjectIndexedLink(char*,int,char**,char**,char**,int*,ObjID**,int*,ObjID**): Retrieves an internal link information.
o GetAffectedObjectLinksCount(char*,int*): Retrieves the number of internal links between affected objects stored in an action
specified by its secondary id.
o GetAttribute(char*,char*,char**): Get the value of an attribute for an action in the INDEX (VPMADM.
o GetModifiedLinks(char*,int*,ObjID**): Retrieves the list of product strucutre links modified within an action
specified by its secondary id.
o GetProduct(char*,ObjID*): Get the product of an action from its id
o GetStatus(char*,char**): Retrieves the status of an action specified by its secondary id.

Methods

o GetAction

public static Error GetAction(	const char*	`iWorkingEffectivity`,
	char**	`oActionID`)

Get the ID of an Action from its working effectivity

Parameters:

iWorkingEffectivity: action working effectivity
oActionID: action secondary id (*oActionID needs to be freed)

o GetAffectedObjectIndexedLink

public static Error GetAffectedObjectIndexedLink(	const char*	`iActionSecondaryId`,
	int	`iIndex`,
	char**	`oLinkName`,
	char**	`oLinkType`,
	char**	`oLinkDesc`,
	int*	`oSourceObjCount`,
	ObjID**	`oSourceObjArray`,
	int*	`oTargetObjCount`,
	ObjID**	`oTargetObjArray`)

Retrieves an internal link information.

Parameters:

iActionSecondaryId: action secondary id
iIndex: link index (between 1 and number of links given by GetAffectedObjectLinksCount
oLinkName: link name
oLinkType: link type
oLinkDesc: link description
oSourceObjCount: number of affected objects on source side of link
oSourceObjArray: array of affected objects on source side of link
oTargetObjCount: number of affected objects on target side of link
oTargetObjArray: array of affected objects on target side of link

o GetAffectedObjectLinksCount

public static Error GetAffectedObjectLinksCount(	const char*	`iActionSecondaryId`,
	int*	`oNbAOLinks`)

Retrieves the number of internal links between affected objects stored in an action
specified by its secondary id.

Parameters:

iActionSecondaryId: action secondary id
oNbAOLinks: number of internal links between action's affected objects

o GetAttribute

public static Error GetAttribute(	const char*	`iActionSecondaryId`,
	char*	`iAttributeName`,
	char**	`oAttributeValue`)

Get the value of an attribute for an action in the INDEX (VPMADM.Action table) from its name instead of in the blob (VPMADM.RDB_DOC_BLOB). This allows better performance.

Parameters:

iActionSecondaryId: action secondary id
iAttributeName: Name of the attribute
iAttributeValue: Value of the attribute (*oAttributeValue needs to be freed)

o GetModifiedLinks

public static Error GetModifiedLinks(	const char*	`iActionSecondaryId`,
	int*	`oNbLinks`,
	ObjID**	`oLinkArray`)

Retrieves the list of product strucutre links modified within an action
specified by its secondary id.

Parameters:

iActionSecondaryId: action secondary id
oNbLinks: number of product structure links modified by the action
oLinkArray: array of links represented as ObjID structures (cf DatabaseAccess)

o GetProduct

public static Error GetProduct(	const char*	`iActionSecondaryId`,
	ObjID*	`oProduct`)

Get the product of an action from its id

Parameters:

iActionId: action secondary id
oProduct: prduct of the action

o GetStatus

public static Error GetStatus(	const char*	`iActionSecondaryId`,
	char**	`oStatus`)

Retrieves the status of an action specified by its secondary id.

Parameters:

iActionSecondaryId: action secondary id
oStatus: action status

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