Description
This method checks the status of an object in the design tool. This call is made to the design tool when an object is found missing in the published data, but published or claimed previously. Such an object is either deleted, moved, or unclaimed. The return value should be one of the first three of the following enumerations.
enum (
Deleted = 1,
Moved = 2,
Unclaimed = 3,
UIDUpdated = 4
} ObjectStatusInTool
If the return value is Deleted, a tombstone will be generated. If the return value is Moved, the object will be added to a moved object collection. If the return value is Unclaimed, an unclaim instruction is generated and the object will be added to the unclaimed object collection in SmartPlant Foundation.
This method is also called when a moved object existence is checked.
Starting with version 3.7, a new status to object is added, UIDUpdated status. Tools
that can return UIDUpdated status for an object should implement IEFAdapter4 interface.
The IEFAdapter4 interface also has the GetObjectStatusInTool method. (For details
on IEFAdapter4 interface, see IEFAdapter4 Interface Class.)
Arguments
|
Name |
Data type |
Input/output |
Description |
|---|---|---|---|
|
sObjUID |
String (maximum 128 characters) |
Input |
UID of the object. |
|
sClassUID |
String (maximum 128 characters) |
Input |
UID of the class definition of the object. |
Return Value
ObjectStatusInTool
Comments
If the method fails, the tool will raise an error and set Err.Number and Err.Description appropriately.