Description
This method checks the status of a relationship object in the design tool. This call is made to the design tool when a relationship object is found to be missing from the published data, but was previously published or claimed. Such a relationship 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 relationship object will be added to a moved object collection. If the return value is Unclaimed, an UnclaimedInstruction is generated and the relationship object will be added to an unclaimed object collection in SmartPlant Foundation.
If the return value is UIDUpdated, sObjNewUID must be returned with the new UID value of the object. For UIDUpdated status, an UpdateUIDInstruction is generated.
Arguments
|
Name |
Data type |
Input/output |
Description |
|---|---|---|---|
|
sRelUID |
String (maximum 128 characters) |
Input |
UID of the relationship object. |
|
sRelName |
String (maximum 70 characters) |
Input |
Name of the relationship. |
|
sClassUID |
String (maximum 128 characters) |
Input |
UID of the class definition of the relationship object. |
|
sRelNewUID |
String (maximum 128 characters) |
Input |
The new UID of the relationship. This value is returned only when the method return status is UIDUpdated. |
Return Value
ObjectStatusInTool
Comments
If the method fails, the tool will raise an error and set Err.Number and Err.Description appropriately.