Class FoundReference
- Namespace
- ArcanaDevelopment.adTempus.Client
- Assembly
- ArcanaDevelopment.adTempus.Client.dll
Represents a found reference to an ADTIndependentObject from another ADTObject.
public class FoundReference- Inheritance
-
objectFoundReference
Properties
CanModify
Indicates whether this reference can be modified.
[ReservedForFutureUse]
public bool CanModify { get; }Property Value
- bool
Messages
Collection of messages reporting any problems encountered during a replace operation
public MessageCollection Messages { get; }Property Value
ReferenceDescription
Gets user-friendly text describing the reference
public string ReferenceDescription { get; }Property Value
- string
ReferencingObject
The object that references the target object
public ADTObject ReferencingObject { get; }Property Value
ReferencingObjectOID
The OID of the ReferencingObject
public OID ReferencingObjectOID { get; }Property Value
ReplacementSucceeded
After a replacement operation, indicates whether this replacement was successful
public bool ReplacementSucceeded { get; }Property Value
- bool
TopLevelObject
The top-level owner of the ReferencingObject
public ADTObject TopLevelObject { get; }Property Value
Remarks
If the ReferencingObject is an ADTIndependentObject, the TopLevelObject will be set to the ReferencingObject. Otherwise it will be set to the ADTIndependentObject that owns (directly or indirectly) the ReferencingObject. For example, if the ReferencingObject is a Task, the TopLevelObject will be the Job that owns the JobStep that owns the Task.
TopLevelObjectDescription
The description of the referencing object
public string TopLevelObjectDescription { get; }Property Value
- string
TopLevelObjectOID
The OID of the TopLevelObject
public OID TopLevelObjectOID { get; }