All Categories  Class Hierarchy  This Category  Previous  Next  Indexes

User-exit Class CATVpmAFUsrMethod

CATVpmAFUsrMethod

public class CATVpmAFUsrMethod

This class regroups the user exits for Action Flow.
These user exits are static methods called by the Action Flow component, and which content can be modified by the customer to suit their specific needs.

Method Index

o CheckTransfer(CATINEOVpmAFAction_var&,char*,char*): Checks if the transfer of the Action is allowed
o CheckUsrCondition(char*,char*): Status Graph customization :
Checks a user condition associated to a status change transition :
if an error is returned, (i.
o CheckUsrLibraryAccess(char*,char**): Action Property Editor customization :
Checks access to an external file when trying to associate it to the action
(by reference) : if an error is returned (i.
o ExecuteUsrCommand(char*,int&,char**): Status Graph customization :
Executes a user command related to a Status Graph transition.
o GetNewUsrPersonId(char*,char**): Status Graph customization :
Retrieves the person identifier relating to a ":Notify" generic command,
using the ":EXT" parameter - i.
o GetSitePrefix(char*,char**): Action multi-site management
Gets the site prefix for action primary id uniqueness; it is 3 characters long.
o GetUsrMessageText(char*,char**,char**): Status Graph customization :
Retrieves the message relating to a ":Notify" generic command.
o GetUsrSecondaryId(char**,char&): Action Property Editor customization :
Retrieves action secondary id when creating a new action in
"secondary id" mode.
o ModifySecondaryId(char*,char*,char*,char,char&,char**): Action Property Editor customization :
Retrieves action secondary id when user modifies action type or id in
"secondary id" mode.
o ModifyType(char*,char**): Action Type customization
o WhenActionIsGenerated(CATINEOVpmAFAction_var&): Manage the action when it is generated
o WhenActionIsSaved(CATINEOVpmAFAction_var&): Manage the action when it is saved

o _CurrentAction
o _CurrentActionProduct

Methods

o CheckTransfer

public static Error CheckTransfer(	const CATINEOVpmAFAction_var&	`iAction`,
	const char*	`iOwner`,
	const char*	`iOrganization`)

Checks if the transfer of the Action is allowed

Parameters:

iAction: Action handler
iOwner: New owner of the Action
iOrganization: New organization of the Action

Returns:

error object

o CheckUsrCondition

public static Error CheckUsrCondition(	const char*	`iConditionName`,
	const char*	`iOperationName`)

Status Graph customization :
Checks a user condition associated to a status change transition :
if an error is returned, (i.e. Ier != 0), the condition is false,
otherwise it is true and the operation which it applies to is executed.

Parameters:

iConditionName: condition name as defined in the Status Graph
iOperationName: operation name as defined in the Status Graph, which the condition applies to

Returns:

error object

o CheckUsrLibraryAccess

public static Error CheckUsrLibraryAccess(	const char*	`iCurrentFullFileName`,
	char**	`oNewFullFileName`)

Action Property Editor customization :
Checks access to an external file when trying to associate it to the action
(by reference) : if an error is returned (i.e. Ier != 0), the file is
not accessible and therefore, the file is not associated while
the error message is displayed.
Also retrieves an updated pathname for this file where accessible.

Parameters:

iCurrentFullFileName: full pathname of the selected file
oNewFullFileName: full pathname of the accessible file (if NULL, the input name is used)

Returns:

error object

o ExecuteUsrCommand

public static Error ExecuteUsrCommand(	const char*	`iCommandName`,
	const int&	`iNbParam`,
	char**	`iParamList`)

Status Graph customization :
Executes a user command related to a Status Graph transition.

Parameters:

iCommandName: command name as defined in the Status Graph
iNbParam: number of command parameters
iParamList: command parameters passed as a iNbParam sized array of strings

Returns:

error object

o GetNewUsrPersonId

public static Error GetNewUsrPersonId(	const char*	`iOperationName`,
	char**	`oPersonId`)

Status Graph customization :
Retrieves the person identifier relating to a ":Notify" generic command,
using the ":EXT" parameter - i.e. the recipient of the notification.

Parameters:

iOperationName: operation name as defined in the Status Graph
oPersonId: person identifier of the notification recipient

Returns:

error object

o GetSitePrefix

public static Error GetSitePrefix(	const char*	`iSiteName`,
	char**	`oSitePrefix`)

Action multi-site management

Gets the site prefix for action primary id uniqueness; it is 3 characters long. The primary id of an action is then:
TYPE SITE NUMBER
[1-3][4-6][7-80]

Parameters:

iSiteName: Site name in P&O table
oSitePrefix: Site prefix for primary id of actions

Returns:

error object

o GetUsrMessageText

public static Error GetUsrMessageText(	const char*	`iOperationName`,
	char**	`oMessageTitle`,
	char**	`oMessageText`)

Status Graph customization :
Retrieves the message relating to a ":Notify" generic command.

Parameters:

iOperationName: operation name as defined in the Status Graph
oMessageTitle: title (subject) of the message
oMessageText: full message text

Returns:

error object

o GetUsrSecondaryId

public static Error GetUsrSecondaryId(	char**	`oSecondId`,
	char&	`oModifiable`)

Action Property Editor customization :
Retrieves action secondary id when creating a new action in
"secondary id" mode.
NOTE : this user exit is not called any more and has just been
maintained in this header for compatibility reasons (see
ModifySecondaryId method).

Parameters:

oSecondId: action secondary id
oModifiable: indicates if the action name (i.e. secondary id) can be edited from within the Action Property Editor window : 'Y' : yes, the action name can be edited otherwise : the action name cannot be modified

Returns:

error object

o ModifySecondaryId

public static Error ModifySecondaryId(	const char*	`iTypePrefix`,
	const char*	`iTypeName`,
	const char*	`iCurrentId`,
	char	`iClashMode`,
	char&	`ioModifiable`,
	char**	`oNewId`)

Action Property Editor customization :
Retrieves action secondary id when user modifies action type or id in
"secondary id" mode.

Parameters:

iTypePrefix: action type prefix
iTypeName: action type name
iCurrentId: action current secondary id (since last modified)
iClashMode: = 'Y' if save attempt has been made and resulted in a clash due to an existing action with the same id
ioModifiable: indicates if the action name (i.e. secondary id) can be edited from within the Action Property Editor window : 'Y' : yes, the action name can be edited otherwise : the action name cannot be modified
oNewId: action secondary id

Returns:

error object

o ModifyType

public static Error ModifyType(	const char*	`iTypeName`,
	char**	`oTypeName`)

Action Type customization

Parameters:

iTypeName: Current Action type name
oTypeName: New Action type name

o WhenActionIsGenerated

public static Error WhenActionIsGenerated( CATINEOVpmAFAction_var& iAction)

Manage the action when it is generated

Parameters:

iAction: Action handler

Returns:

error object

o WhenActionIsSaved

public static Error WhenActionIsSaved( CATINEOVpmAFAction_var& iAction)

Manage the action when it is saved

Parameters:

iAction: Action handler

Returns:

error object

Data Members

o _CurrentAction

  public static Action _CurrentAction

o _CurrentActionProduct

  public static ObjID _CurrentActionProduct

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

User-exit Class CATVpmAFUsrMethod

Method Index

Data Member Index

Methods

Data Members