ReviseDocuments
Description
SmartPlant Client passes the currently-selected revision values for documents to the publishing tool in this method. The revision values for each document were used to create a reserved revision in SmartPlant Foundation for the document. SP Client expects the publishing tool to save the values so that the tool can return the values in the tool’s implementation of ISPAdapter2.GetRevision. SP Client only calls this method if the publishing tool’s implementation of SupportFeature returns True for SPFRevisions.
If the publishing tool employs the UI version of SmartPlant Common UI, SP Client calls this method after the user clicks the OK button on the Revise window. If the tool employs the non-UI version of SP Common UI, SP Client calls the tool’s SP Adapter’s implementation of ISPAdapter2.ReviseDocuments during the execution of SP Common UI’s implementation of ISPClientApplicationNoUI.ReviseDocuments.
The oDocs parameter contains document objects for which revisions have been reserved in SmartPlant Foundation. The oDevRevs parameter contains document revision objects, one for each document object in oDocs.
Arguments
|
Name |
Data type |
Input/output |
Description |
|---|---|---|---|
|
oDocs |
IContainer |
Input |
Schema Component container object with documents for which revisions were reserved. |
|
oDocRevs |
IContainer |
Input |
Schema Component container object with a document revision object each document object in oDocs container. |
Return Value
None.
Comments
If the method fails, the tool will raise an error.
GetRevision
Description
This method returns the current revision of a document in the tool, typically during a publish transaction. SmartPlant Client only calls this method if the publishing tool’s implementation of SupportFeature returns True for SPFRevisions.
The input parameter specifies the document for which this method returns the current major and minor revision values stored by the publishing tool. A document may lack a minor revision value.
Arguments
|
Name |
Data type |
Input/output |
Description |
|---|---|---|---|
|
oDocObj |
IObject |
Input |
Document IObject. |
|
sMajorRev |
String |
Output |
Current major revision number. |
|
sMinorRev |
String |
Output |
Current major revision number. |
Return Value
None.
Comments
If the method fails, the tool will raise an error.