All Frameworks Class Hierarchy This Framework Next Indexes
VPMSTEPExchanges Interface ENOVIExDataServices
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---ENOVIExDataServices
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface ENOVIExDataServices
Description of the ENOVIExDataServices Interface.
Role: This interface offers useful services for export / import processes.
It particularly allows to manage attributes, lists of extracted objects.
Method Index
- o
ExportAttributs(CATBaseUnknown* const,SdaiAppInstanceH const,int,CATListOfCATUnicodeString* const,CATListOfCATUnicodeString&)
- Exports ENOVIA-LCA object's attributes to ENOV_DATAX object.
- o
ImportAttributs(int,SdaiAppInstanceH const,CATBaseUnknown* const,int,CATListOfCATUnicodeString* const,CATListOfCATUnicodeString&)
- Imports ENOV_DATAX entity's attributes to ENOVIA-LCA object.
- o
Register(CATBaseUnknown* const,SdaiAppInstanceH const)
- Registers an existing couple of ENOVIA-LCA/ENOV_DATAX objects.
- o
RetrieveFrom(CATBaseUnknown* const,SdaiAppInstanceH&,SdaiModelH,CATUnicodeString&,CATUnicodeString)
- Retrieves an ENOV_DATAX entity corresponding to a given ENOVIA-LCA object.
- o
RetrieveFrom(SdaiAppInstanceH,CATBaseUnknown*&,CATUnicodeString&)
- Retrieves an exported ENOVIA-LCA object from the corresponding ENOV_DATAX entity.
- o
getAttributsByPermission(SdaiAppInstanceH const,int,CATListOfCATUnicodeString&)
- Retrieves the list of an object's attributes holding a given permission.
Methods
o ExportAttributs
-
Exports ENOVIA-LCA object's attributes to ENOV_DATAX object.
Role: This method is called in an extractor during an export process.
It allows to map attributes values between ENOVIA-LCA object and ENOV_DATAX entity,
in accordance with the READ rights defined in the attributes rules file.
- Parameters:
-
- iLCASourceObj
- ENOVIA-LCA source object
- oEDXDestObject
- ENOV_DATAX destination entity
- iRules
- This parameter is not currently used
Legal values: 0
- pExceptionAttributsList
- List of attributes that should not be taken into account.
Note that all ENOV_DATAX "private" attributes Q_... are automatically ignored
- oListFailedAttr
- List of attributes of which value extraction failed
- Returns:
- Returns S_OK if all attributes could be correctly extracted to ENOV_DATAX else returns E_FAIL
o ImportAttributs
-
Imports ENOV_DATAX entity's attributes to ENOVIA-LCA object.
Role: This method is called in a merger during an import process.
It allows to map attributes values between ENOV_DATAX entity and ENOVIA-LCA object.
If data already exist in ENOVIA-LCA, they will be reconciliated in accordance with
the WRITE rights defined in the attributes rules file.
- Parameters:
-
- iProcessKind
- Specifies if this is a creation or reconciliation process
Legal values
ExCREATION_PROCESS,ExRECONCILIATION_PROCESS
- iEDXSourceObject
- ENOV_DATAX source entity
- oLCADestObj,
- ENOVIA-LCA destination object
- iRules
- This parameter is not currently used
Legal values: 0
- pExceptionAttributsList
- List of attributes that should not be taken into account.
Note that all ENOV_DATAX "private" attributes Q_... are automatically ignored
- oListFailedAttr
- List of attributes of which import failed
- Returns:
- Returns S_OK if all attributes could be correctly imported to ENOVIA-LCA else returns E_FAIL
o Register
-
Registers an existing couple of ENOVIA-LCA/ENOV_DATAX objects.
Role: This method is called in an extractor during an export process.
It allows to store a list of all the objects that have already been exported and
the corresponding ENOV_DATAX entities. The purpose is to be able to retrieve exported
objects when needed during the expor tprocess.
- Parameters:
-
- pLCAObj
- ENOVIA-LCA object
- pEDXObj
- ENOV_DATAX entity
- Returns:
- Returns S_OK if the objects couple could be correctly registered else returns E_FAIL
o RetrieveFrom
-
Retrieves an ENOV_DATAX entity corresponding to a given ENOVIA-LCA object.
Role: This method is called in a merger during an import process.
It allows to retrieve an ENOV_DATAX entity corresponding to a given object,
using the input key attribute.
- Parameters:
-
- piSourceLCAObject
- ENOVIA-LCA object
- rRetrievedEDXObject
- Retrieved ENOV_DATAX entity
- pSourceModel
- SDAI model in which the entity must be looked for
- rEDXType
- ENOV_DATAX type of the retrieved entity
- usAttributeKeyName
- Key attribute to be used to retrieve the ENOV_DATAX entity
Default value
"Q_uuid"
- Returns:
- Returns S_OK if the ENOV_DATAX entity could be retrieved else returns E_FAIL
o RetrieveFrom
-
Retrieves an exported ENOVIA-LCA object from the corresponding ENOV_DATAX entity.
Role: This method is called in an extractor during an export process.
It allows to retrieve an object that has already been exported from the corresponding
ENOV_DATAX entity. This couple ENOVIA-LCA object/ENOV_DATAX entity must have been
previously registered through the method Register.
- Parameters:
-
- pSourceEDXObject
- ENOV_DATAX entity
- piRetrievedLCAObject
- Retrieved ENOVIA-LCA object
- usAttributeKeyName
- Key attribute to be used to retrieve ENOVIA-LCA object
Default value
"Q_uuid"
- Returns:
- Returns S_OK if the ENOVIA-LCA object could be retrieved else returns E_FAIL
o getAttributsByPermission
-
Retrieves the list of an object's attributes holding a given permission.
Role: This method returns a list of the readable or writable attributes
of the given ENOV_DATAX entity. It may be called in an extractor with "readable"
permission or in a merger with "writable" permission.
- Parameters:
-
- pEDXObj
- ENOV_DATAX entity
- nPermission
- Permission of the attributes to retrieve
Legal values
1 for readable attributes, 2 for writable attributes
- rListOfAttr
- List of the attributes corresponding to the given permission
- Returns:
- Returns S_OK if attributes could be correctly retrieved else returns E_FAIL
This object is included in the file: ENOVIExDataServices.h
If needed, your Imakefile.mk should include the module: GUIDVPMSTEPExchanges