There will be a Retrieve command in the design tool’s menu to display retrievable documents. When a user clicks on that command, the design tool should call the ShowRetrieveDialog method.
This method will display a dialog box that shows a list of documents that are ready for retrieval by the tool in the current plant/project context. The dialog box allows users to select one or more documents and invoke the retrieve operation.
This method has an optional argument to specify the document types (IEFDocTypes). When this argument is passed, documents belonging to the specified document types will be displayed in the Retrieve dialog box.
The list of documents in the Retrieve dialog box includes the PBS document and WBS document if there are new versions in SmartPlant Foundation since the last retrieval of these documents.
When the user clicks OK button, EFCommonUI will communicate with EFClient to retrieve the documents from SmartPlant Foundation, and will call the RetrieveDocument method on EFAdapter.
The project/plant context for retrieve operations is the same as the context set
in the Connect method. Before calling the retrieve method, the design tool must make
sure that the context for retrieve is the same as the context set in the Connect method.
If the retrieve context is different, the Connect method should be called again with
the right context.
Arguments
|
Name |
Data type |
Input/output |
Description |
|---|---|---|---|
|
ODocTypes |
IEFDocTypes |
Input |
Optional argument to specify document types (DocType UIDs). When specified, the Retrieve dialog box will display retrievable documents belonging to the specified document types. |
Return Value
0 if the method is successful.
1 if the user cancels the operation in publish wizard.
A negative number if method fails. (Check the LastErrorMessage property for error message.)
Comments
None