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 missing in the published data, but published or claimed previously. 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, and UnclaimedInstruction is generated and the relationship
Starting with version 3.7, a new status to relationship is added, UIDUpdated status.
Tools that can return UIDUpdated status for a relationship should implement IEFAdapter4
interface. The IEFAdapter4 interface also has the GetRelationshipStatusInTool method.
(For details on IEFAdapter4 interface, see IEFAdapter4 Interface Class.)
Arguments
|
Name |
Data type |
Input/output |
Description |
|---|---|---|---|
|
sRelUID |
String (maximum 128 characters) |
Input |
UID of the relationship object. |
|
sClassUID |
String (maximum 128 characters) |
Input |
UID of the class definition of the relationship object. |
Return Value
ObjectStatusInTool
Comments
If the method fails, the tool will raise an error and set Err.Number and Err.Description appropriately.