Class EventOccurrenceSearch

Namespace

Geotab.Checkmate.ObjectModel

Assembly

Geotab.Checkmate.ObjectModel.dll

false search The object used to specify the arguments when searching for EventOccurrence(s).

public class EventOccurrenceSearch : Search, IEntity

Inheritance

object

Search

EventOccurrenceSearch

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

EventOccurrenceSearch()

public EventOccurrenceSearch()

Properties

ActiveOnly

Gets or sets a value indicating whether gets or sets search for active EventOccurrences recorded Only.

public bool ActiveOnly { get; set; }

Property Value

bool

bool

DeviceIds

Gets or sets a list of Device Ids to search by. Device

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

Property Value

IEnumerable<Id>

Array>Id

DeviceSearch

Gets or sets search for EventOccurrences matching this DeviceSearch. Providing a device ID will search for any EventOccurrences that are assigned to that Device. Providing the Groups will search for EventOccurrences for that have Devices in that group. Available DeviceSearch options are:.

public DeviceSearch? DeviceSearch { get; set; }

Property Value

DeviceSearch

DeviceSearch

EventRuleIds

Gets or sets a list of EventRule Ids to search by. MaintenanceSchedule

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

Property Value

IEnumerable<Id>

Array>Id

EventRuleSearch

Gets or sets search for EventOccurrences matching this MaintenanceScheduleSearch. Providing a event rule id will search for any EventOccurrences that are assigned to that Event Rule. Providing the Groups will search for EventOccurrences for that have Event Rules in that group. Available EventRuleSearch options are:.

public MaintenanceScheduleSearch? EventRuleSearch { get; set; }

Property Value

MaintenanceScheduleSearch

MaintenanceScheduleSearch

EventTypeIds

Gets or sets a list of EventType Ids to search by. EventType

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

Property Value

IEnumerable<Id>

Array>Id

FromDate

Gets or sets search for EventOccurrences recorded at this date or after.

public DateTime? FromDate { get; set; }

Property Value

DateTime?

DateTime

IncludeHistoricDevices

Gets or sets a value indicating whether event has historic devices.

public bool? IncludeHistoricDevices { get; set; }

Property Value

bool?

bool

IncludeSkipped

Gets or sets a value indicating whether event is skipped.

public bool? IncludeSkipped { get; set; }

Property Value

bool?

bool

IncludeSkippedMaintenance

Gets or sets a value indicating whether searching for 'skipped' maintenance.

public bool? IncludeSkippedMaintenance { get; set; }

Property Value

bool?

bool

IncludeUnplannedMaintenance

Gets or sets a value indicating whether searching for 'unplanned maintenance'.

public bool? IncludeUnplannedMaintenance { get; set; }

Property Value

bool?

bool

Keywords

Gets or sets search for entities that contain specific keywords in all wildcard string-searchable fields.

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

Property Value

IEnumerable<string>

IList<T> where T is string.

LatestRecordsOnly

Gets or sets a value indicating whether the search returns latest EventOccurrence records only.

public bool LatestRecordsOnly { get; set; }

Property Value

bool

bool

MaxId

Gets or sets gets maximum Id of the search criteria.

public Id? MaxId { get; set; }

Property Value

Id

Id

MinId

Gets or sets gets minimum Id of the search criteria.

public Id? MinId { get; set; }

Property Value

Id

Id

ReturnLinkageEvents

Gets or sets a value indicating whether search returns linkage EventOccurrence records for once-off MaintenanceSchedule.

public bool ReturnLinkageEvents { get; set; }

Property Value

bool

bool

ToDate

Gets or sets search for EventOccurrences recorded at this date or before.

public DateTime? ToDate { get; set; }

Property Value

DateTime?

DateTime