Class FaultDataSearch

Namespace

Geotab.Checkmate.ObjectModel.Engine

Assembly

Geotab.Checkmate.ObjectModel.dll

true search

The object used to specify the arguments when searching for a FaultData.

This search has been designed to work efficiently with these combinations of parameters:

public class FaultDataSearch : Search, IEntity

Inheritance

object

Search

FaultDataSearch

Implements

IEntity

Inherited Members

Search.Clone()

Search.GetReadOnly()

Search.Id

Search.Version

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

FaultDataSearch()

Initializes a new instance of the FaultDataSearch class.

public FaultDataSearch()

FaultDataSearch(Id?)

Initializes a new instance of the FaultDataSearch class.

public FaultDataSearch(Id? id)

Parameters

id Id

The id.

Properties

ControllerSearch

Gets or sets the search options which are used to search for fault data for a controller ControllerSearch by Id. Available ControllerSearch options are:.

public ControllerSearch? ControllerSearch { get; set; }

Property Value

ControllerSearch

ControllerSearch

DeviceSearch

Gets or sets search for FaultData(s) from a device that matches the DeviceSearch Id or in the Groups specified. This includes archived and deleted devices. Available DeviceSearch options are:.

public DeviceSearch? DeviceSearch { get; set; }

Property Value

DeviceSearch

DeviceSearch

DiagnosticSearch

Gets or sets search for FaultData recorded for the diagnostic code using the DiagnosticSearch Id. Available DiagnosticSearch options are:.

public DiagnosticSearch? DiagnosticSearch { get; set; }

Property Value

DiagnosticSearch

DiagnosticSearch

ExcludeDismissed

Gets or sets a value indicating whether exclude Dismissed faults.

public bool ExcludeDismissed { get; set; }

Property Value

bool

A bool value.

FromDate

Gets or sets the from date. The FaultData logs are searched for events which were recorded on or after this date.

public DateTime? FromDate { get; set; }

Property Value

DateTime?

DateTime

GroupFilterCondition

Gets or sets for fault data group list search.

[Obsolete("Use the GroupFilterCondition property of the DeviceSearch object instead.")]
public GroupFilterCondition? GroupFilterCondition { get; set; }

Property Value

GroupFilterCondition

GroupFilterCondition

Groups

Gets or sets the groups which should be searched. GroupSearch(s). Available GroupSearch options are:.

[Obsolete("Use the Groups property of the DeviceSearch object instead.")]
public List<GroupSearch>? Groups { get; set; }

Property Value

List<GroupSearch>

The groups which should be searched. GroupSearch(s). Available GroupSearch options are:.

Ids

Gets or sets search for FaultData with these unique Id(s).

public IEnumerable<Id>? Ids { get; set; }

Property Value

IEnumerable<Id>

IList<T>

IncludeDetails

Gets or sets a value indicating whether entities details information should be included.

public bool IncludeDetails { get; set; }

Property Value

bool

A bool value.

InclusiveSearch

Gets or sets inclusive search flag.

public bool? InclusiveSearch { get; set; }

Property Value

bool?

bool

OnlyLast

Gets or sets a value indicating whether only the last fault data record should be retrieved.

public bool OnlyLast { get; set; }

Property Value

bool

A bool value.

SeverityCodes

Gets or sets a value indicating the severity codes to search for.

public IEnumerable<string>? SeverityCodes { get; set; }

Property Value

IEnumerable<string>

A IList<T> value.

State

Gets or sets the to state of the fault. The Fault data logs are searched for events which are under the this state.

public FaultState? State { get; set; }

Property Value

FaultState?

FaultState

ToDate

Gets or sets the to date. The Fault data logs are searched for events which were recorded on or before this date.

public DateTime? ToDate { get; set; }

Property Value

DateTime?

DateTime