All Frameworks Class Hierarchy This Framework Previous Next Indexes
VPMDesktopProduct Class ENOVUserExitServices
ENOVUserExitServices
Usage: you must use this class as is. You should never derive it.
public class ENOVUserExitServices
Class to provide a set of services for user exits.
Role: At the Application Server level, there are some services and functionnalities
that can be used in the user exit code.
Method Index
- o
CreateHistory(CATIVpmFactoryObject_var&,CATUnicodeString&,CATUnicodeString&)
- Allows the caller to create a history entry for an object.
- o
getCurrentActionMod(CATIVpmAFLAction_var&,CATICfgModification_var&)
- Gets the current action of the current (active) product editor.
- o
getCurrentPRC(ENOVIABOProductRootClass_var&)
- Gets the current PRC of the current (active) product editor.
- o
getDataDomain(CATUnicodeString&)
- Retrieves the current environment.
- o
getName(CATUnicodeString&)
- This method gets the type of objects.
- o
setCurrentAction(CATUnicodeString&)
- Sets the current action of the product editor.
- o
setCurrentModification(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&)
- Set a current action and modification for a configured PRC.
- o
setDataDomain(CATUnicodeString&)
- Sets the current environment.
- o
setMask(CATUnicodeString&)
- Sets the current mask to be used for attribute listing.
Methods
o CreateHistory
-
Allows the caller to create a history entry for an object. The entry
is visible in the History tab of the Identity Card for an object.
- Parameters:
-
- iObj
- The object for which history is to be created.
- iHistoryType
- Value of the HIS_TYPE attribute in OBHISTORY.
- iHistoryDesc
- Value of the DESCRIPTION attribute in OBHISTORY.
- Returns:
- 1 Everything is OK, 0 An error occured.
o getCurrentActionMod
public static int getCurrentActionMod( | CATIVpmAFLAction_var& | oAction, |
| CATICfgModification_var& | oModif) |
-
Gets the current action of the current (active) product editor.
- Parameters:
-
- oAction
- action that is set in the current ProductEditor session (if no action is set or no active PE session, it is NULL)
- oModif
- modif that is set in the current ProductEditor session (if no modif is set or no active PE session, it is NULL)
- Returns:
- 1 Everything is OK, 0 An error occured.
o getCurrentPRC
public static int getCurrentPRC( | ENOVIABOProductRootClass_var& | oPRC) |
-
Gets the current PRC of the current (active) product editor.
- Parameters:
-
- oPRC
- PRC that is set in the current ProductEditor session (if no action is set or no active PE session, it is NULL)
- Returns:
- 1 Everything is OK, 0 An error occured.
o getDataDomain
-
Retrieves the current environment.
- Parameters:
-
- oDataDomain
- The current environment.
- Returns:
- 1 Everything is OK, 0 An error occured.
o getName
-
This method gets the type of objects. This is required to identify them,
and then execute some code according to this type (is my object a
document ? an action ? a part ?).
- Parameters:
-
- iIdentifier
- The build-time name to identify a type.
- Returns:
- The run-time name corresponding to the name.
o setCurrentAction
-
Sets the current action of the product editor.
- Parameters:
-
- iActionUUID
- The identifier of the action.
- Returns:
- 1 Everything is OK, 0 An error occured.
o setCurrentModification
-
Set a current action and modification for a configured PRC.
The following conditions must be met:
The input mod must be a valid mod on the input action and PRC.
The input action must not be frozen.
There must not be an active Product Editor catlet associated with the session.
In case of non-successful return code (result != 1), the current action/mod will be set to NULL.
- Parameters:
-
- iActionName
-
- iModName
-
- Returns:
- 1 Current action and mod are set successfully. -1 there is an active product editor catlet for this session
-2 invalid PRCName: PRC does not exist or is not configured
-3 invalid ModName: no mod with this name for this PRC
-4 invalid ActionName: no action with this name for this mod
-5 input action is frozen
0 unexpected errors
o setDataDomain
-
Sets the current environment. This is useful for object creation for example.
- Parameters:
-
- iDataDomain
- The current environment to set.
- Returns:
- 1 Everything is OK, 0 An error occured.
o setMask
-
Sets the current mask to be used for attribute listing.
- Parameters:
-
- iMaskToSet
- The name of the mask to use.
Legal values
create when creating objects,
query when defining filters to perform query,
write when updating objects,
read when browsing objects.
- Returns:
- 1 Everything is OK, 0 An error occured (name unknown for example).
This object is included in the file: ENOVUserExitServices.h
If needed, your Imakefile.mk should include the module: VDP0OrbCustoCommand