All Frameworks Class Hierarchy This Framework Indexes Previous Next

XPGBatchUtilityItf Interface CATIXPDMPostProcessing

Usage: you can freely reimplement this interface.

interface CATIXPDMPostProcessing

This interface is called to launch a post-process operation of the XPGClientBatch processings.

Role: This interface is used to call a Postprocessing implementation, after import or export transaction of the XPGClientBatch.
The XPGClientBatch will set all necessary information to implement the post-processing using the SetXXX methods.
After an Import, the PostProcessXPDMImport method is called.
After an export, the PostProcessXPDMExport method is called with the selected source objects as input.
At the end of the post-process, the XPGClientBatch will retrieve the result of the post-process with the GetErrorInformation method.
In case of failure of the post-process, the return code and messages of the XPGClientBatch will depend of the information of the previous method.

Method Index

o GetErrorInformation(int&,CATUnicodeString&): Returns the error information about the post-processing execution.
o PostProcessXPDMExport(CATLISTP(CATIAdpPLMIdentificator)&): Call the post-processing after an export.
o PostProcessXPDMImport(): Call the post-processing after an import.
o SetCATIXPDMMappingServices(CATIXPDMMappingServices*&): Set the CATIXPDMMappingServices interface pointer on the post-process implementation.
o SetListOfExchangeParameters(CATListOfCATUnicodeString&,CATListOfCATUnicodeString&): Set the exchange parameters.
o SetListOfProcessingParameters(CATListOfCATUnicodeString&,CATListOfCATUnicodeString&): Set the processing parameters.
o SetLoggingDirectory(CATUnicodeString&): Set a dedicated directory for the post-processing implementation to store report and logging information.
o SetMetaDataFile(CATUnicodeString&,CATUnicodeString&): Set the meta-data file path.

Methods

o GetErrorInformation

public virtual GetErrorInformation(		`oRC`,
		`oErrorMsg`)

Returns the error information about the post-processing execution.
Role: When the post-processing fails, this method is called to retrieve information about the reason.
This information includes a return code as well as a detailed message.

Parameters:

oRC[out]: The return code of the post-processing.
oErrorMsg[out]: The detailed messages.

Returns:

S_OK/S_FALSE: Method call is successfull.
E_XXX: Error.

o PostProcessXPDMExport

public virtual PostProcessXPDMExport( iListSourceObjects)

Call the post-processing after an export.
Role:Called after a sucessfull export.

Parameters:

iListSourceObjects: [in] The list of selected source object.

Returns:

S_OK/S_FALSE: The post-process is successful.
E_XXX: Error in the post-processing.

o PostProcessXPDMImport

public virtual PostProcessXPDMImport(

)

Call the post-processing after an import.
Role:Called after a sucessfull import.

Returns:

S_OK/S_FALSE: The post-process is successful.
E_XXX: Error in the post-processing.

o SetCATIXPDMMappingServices

public virtual SetCATIXPDMMappingServices( ipMappingServices)

Set the CATIXPDMMappingServices interface pointer on the post-process implementation.
Role:This method provides the pointer of the CATIXPDMMappingServices interface.
The implementation can use this interface to retrieve the V6 component identifier from an XPDMXML "External" identifier.

Parameters:

ipMappingServices: [in] The CATIXPDMMappingServices interface pointer. Must NOT be CATBaseUnknown#Release.

Returns:

S_OK/S_FALSE: The set is successful.
E_XXX: Error

o SetListOfExchangeParameters

public virtual SetListOfExchangeParameters(		`iListName`,
		`iListValue`)

Set the exchange parameters.
Role:Provides the list of name and value of the exchange parameters.
The exchange parameters can be set in several ways depending of the scenario:

Using the CustomizedParameters parameter of XPGClientBatch.
Using the SendToXPDM EKL function.
Using the SendEvent(...) web service from the XPDM adapter.

These exchange parameters can be used as criterias for the post-processing implementation.

Parameters:

iListName: [in] The list of parameters name.
iListValue: [in] The list of parameters value.

Returns:

S_OK/S_FALSE: The set is successful.
E_XXX: Error

o SetListOfProcessingParameters

public virtual SetListOfProcessingParameters(		`iListName`,
		`iListValue`)

Set the processing parameters. The processing parameters are the XPGClientBatch parameters.
Role:Provides the list of name and value of the paramaters use for this particular XPGClientBatch execution.

Parameters:

iListName: [in] The list of parameters name.
iListValue: [in] The list of parameters value.

Returns:

S_OK/S_FALSE: The set is successful.
E_XXX: Error

o SetLoggingDirectory

public virtual SetLoggingDirectory( iLogDir)

Set a dedicated directory for the post-processing implementation to store report and logging information.
Role:Provides the absolute path of a directory to store report and logging information.

Parameters:

iLogDir: [in] Absolute path of a directory to store report and logging information.

Returns:

S_OK/S_FALSE: The set is successful.
E_XXX: Error

o SetMetaDataFile

public virtual SetMetaDataFile(		`iWorkingDir`,
		`iFileName`)

Set the meta-data file path.
Role: This method provides the absolute path of the meta-data file.
This file is used as an input and output by the XPGClientBatch for, respectively, import and export scenario.

Parameters:

iWorkingDir: [in] Absolute path of the directory containing the meta-data file.
iFileName: [in] The name of the meta-data file.

Returns:

S_OK/S_FALSE: The set is successful.
E_XXX: internal error

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