There will be a Retrieve command on the design tool menu to display retrievable documents. When a user clicks the Retrieve command, the design tool should call the GetRetrievableDocumentList method.
This method will return a list of documents for given document types (oDocTypes) that are ready for retrieval by the tool in the current plant/project context. The design tool should allow users to select one or more documents and invoke the retrieve operation by calling Retrieve.
This method starts a Retrieve transaction. After this method is called, only the Retrieve or ReleaseRetrieveContainers method can be called to complete the transaction. If any other method is called, an appropriate error message is returned.
If the tool passed the PBS and WBS doc types in oDocTypes, the list of documents returned includes the PBS document and WBS document if there are new versions in SmartPlant Foundation since the last retrieval of these documents.
The project/plant context for retrieve operation 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 |
Doc types for which the retrievable documents will be found. |
oDocIContainer |
IContainer |
Output |
IContainer pointer to the documents container with retrievable document objects. |
oMetaIContainer |
IContainer |
Output |
IContainer pointer to the documents container with retrievable document version objects. |
oSelectedDocIContainer |
IContainer |
Output |
Empty IContainer for the design tool to fill with user selected document objects and pass in the Retrieve method. |
oSelectedMetaIContainer |
IContainer |
Output |
Empty IContainer for the design tool to fill with user selected document version objects and pass in the Retrieve method. |
bOnlyDocsToBeRetrieved |
Boolean |
Input |
Indicates whether to return only documents that need to be retrieved or to return all documents that can be retrieved. |
bAllRevisions |
Boolean |
Input |
Indicates whether to return only the latest Revision of a document or all revisions of a document. |
Return Value
0 if method is successful.
1 if the user cancels the operation in the Publish wizard.
A negative number if method fails. (Check the LastErrorMessage property for error message.)
Comments
After calling this method, the only methods that can be called are Retrieve or ReleaseRetrieveContainers to complete the Retrieve transaction.