Class SearchReplaceResult

Namespace

ArcanaDevelopment.adTempus.Client

Assembly

ArcanaDevelopment.adTempus.Client.dll

Contains the results of a search/replace operation for a single object

public class SearchReplaceResult

Inheritance

object

SearchReplaceResult

Remarks

The search/replace operation returns a SearchReplaceResult for each top-level (IsDependent is false) object in which a match was found. Each SearchReplaceResult contains a SearchReplaceMatch for each location where a match was found, providing additional information about the match and its location.

Properties

Matches

List of locations within the object where a match was found

public List<SearchReplaceMatch> Matches { get; }

Property Value

List<SearchReplaceMatch>

PrimaryObjectDescription

Gets the description of the top-level object.

public string PrimaryObjectDescription { get; }

Property Value

string

PrimaryObjectFetched

Indicates whether the top-level object has been fetched from the server.

public bool PrimaryObjectFetched { get; }

Property Value

bool

PrimaryObjectOID

The OID of the top-level object in which the match was found.

public OID PrimaryObjectOID { get; }

Property Value

OID

Methods

GetPrimaryObject()

Gets the top-level object in which the match was found.

public ADTObject GetPrimaryObject()

Returns

ADTObject

Remarks

If ObjectSearchOptions.ReturnObjects was set to false, the object will be automatically fetched from the server if necessary. If you plan to need the contents of the objects, set ReturnObjects to true when calling SearchAndReplace(ObjectSearchOptions, out ReadOnlyCollection<SearchReplaceResult>, out MessageCollection) so that all objects are returned at once, rather than requiring multiple calls to the server to fetch them individually.