Description
This method is called by EFServiceManager and needs to be implemented to modify, add, or remove information from the data to be retrieved before transmitting to the tool adapter. This implementation can also validate the retrieve data and raise messages during the retrieve process and can also update the progress bar with the status of each step.
-
To log messages, make sure MessageIContainer is set, and add the messages to MessageIContainer. The messages are saved to a log file.
-
To display progress steps in the progress bar, implement ListOfProgressSteps(). For each step, call StepProgress(stepName) before starting the step. Use the member variable of type IEFCustomRetreiveEventHandler with SetEventHandlerObj()
-
For a sample implementation, see Sample Implementation (IEFCustomRetrieve).
Arguments
|
Name |
Data type |
Input/output |
Description |
|---|---|---|---|
|
oDocumentIObject |
IObject |
Input |
IObject interface on the document object. |
|
blnValidateAfterCustomProcess |
Boolean |
Input/Output |
User should set this flag to True is validation is required after custom processing. |
|
oDocIContainer |
IContainer |
Input/Output |
Document container. |
|
oDocMetalContainer |
IContainer |
Input/Output |
Document meta-data container. |
|
oDocTombstonesIContainer |
IContainer |
Input/Output |
Document Tombstone container. |
|
oMapSchContlContainer |
IContainer |
Input |
Optional. Maps the schema container. |