Class DutyStatusLogSearch

Namespace

Geotab.Checkmate.ObjectModel

Assembly

Geotab.Checkmate.ObjectModel.dll

true The object used to specify the arguments when searching for DutyStatusLog(s).

public class DutyStatusLogSearch : Search, IEntity

Inheritance

object

Search

DutyStatusLogSearch

Implements

IEntity

Inherited Members

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

DutyStatusLogSearch()

Initializes a new instance of the DutyStatusLogSearch class.The object used to specify the arguments when searching for DutyStatusLogs.

public DutyStatusLogSearch()

DutyStatusLogSearch(Id)

Initializes a new instance of the DutyStatusLogSearch class. The object used to specify the arguments when searching for DutyStatusLogs.

public DutyStatusLogSearch(Id id)

Parameters

id Id

The Id to search for.

DutyStatusLogSearch(UserSearch?, DeviceSearch?, DateTime?, DateTime?, bool?, IEnumerable<DutyStatusLogType>?, bool?, IList<DutyStatusMalfunctionTypes>?, bool?)

Initializes a new instance of the DutyStatusLogSearch class.The object used to specify the arguments when searching for DutyStatusLogs.

public DutyStatusLogSearch(UserSearch? userSearch, DeviceSearch? deviceSearch = null, DateTime? fromDate = null, DateTime? toDate = null, bool? includeBoundaryLogs = null, IEnumerable<DutyStatusLogType>? statuses = null, bool? includeModifications = null, IList<DutyStatusMalfunctionTypes>? malfunction = null, bool? includeCompliance = null)

Parameters

userSearch UserSearch

Search for DutyStatusLogs with this UserSearch Id.

deviceSearch DeviceSearch

Search for DutyStatusLogs for this DeviceSearch Id.

fromDate DateTime?

The minimum DateTime to search for.

toDate DateTime?

The maximum DateTime to search for.

includeBoundaryLogs bool?

Include boundary logs outside of the from and to dates.

statuses IEnumerable<DutyStatusLogType>

Search for DutyStatusLogs with the provided DutyStatusLogTypes.

includeModifications bool?

Get DutyStatusLog(s) along with any modifications.

malfunction IList<DutyStatusMalfunctionTypes>

A filter for the DutyStatusMalfunctionTypes(s) of a log.

includeCompliance bool?

Include compliance DutyStatusLog(s) logs.

Properties

DeviceSearch

Gets or sets filter by the DeviceSearch options. Providing a device ID will search for any DutyStatusLogs that are assigned to that Device. Providing the Groups will search for DutyStatusLogs for that have Devices in that group. Available DeviceSearch options are: UserSearch is always applied first if both DeviceSearch and UserSearch are provided.

public DeviceSearch? DeviceSearch { get; set; }

Property Value

DeviceSearch

DeviceSearch

FromDate

Gets or sets search for DutyStatusLogs that were recorded at this date or after.

public DateTime? FromDate { get; set; }

Property Value

DateTime?

DateTime

IncludeBoundaryLogs

Gets or sets search for DutyStatusLogs and include boundary logs outside the from and to dates (for example, the log immediately preceding the from date).

public bool? IncludeBoundaryLogs { get; set; }

Property Value

bool?

bool

IncludeCompliance

Gets or sets search for DutyStatusLogs and include compliance properties (e.g. Odometer, EngineHours).

public bool? IncludeCompliance { get; set; }

Property Value

bool?

bool

IncludeLocations

Gets or sets whether to populate locations for DutyStatusLogs. This can be expensive.

public bool? IncludeLocations { get; set; }

Property Value

bool?

bool

IncludeModifications

Gets or sets include modification history of the DutyStatusLog results.

public bool? IncludeModifications { get; set; }

Property Value

bool?

bool

Malfunction

Gets or sets search for DutyStatusLogs based on DutyStatusMalfunctionTypes.

public IList<DutyStatusMalfunctionTypes>? Malfunction { get; set; }

Property Value

IList<DutyStatusMalfunctionTypes>

DutyStatusMalfunctionTypes

MaxVersion

Gets or sets search for DutyStatusLogs with a maximum of this version.

public long? MaxVersion { get; set; }

Property Value

long?

Nullable<T> where T is. long

MinVersion

Gets or sets search for DutyStatusLogs with a minimum of this version.

public long? MinVersion { get; set; }

Property Value

long?

Nullable<T> where T is. long

OnlyDriverDiagnosticsMalfunctions

Gets or sets search for DutyStatusLogs for only the driver's malfunction/diagnostic logs.

public bool? OnlyDriverDiagnosticsMalfunctions { get; set; }

Property Value

bool?

bool

Origin

Gets or sets search for DutyStatusLogs based on DutyStatusOrigin.

public IList<DutyStatusOrigin>? Origin { get; set; }

Property Value

IList<DutyStatusOrigin>

DutyStatusOrigin

Statuses

Gets or sets search for DutyStatusLogs with the provided DutyStatusLogTypes.

public IEnumerable<DutyStatusLogType>? Statuses { get; set; }

Property Value

IEnumerable<DutyStatusLogType>

IList<T> where T is. DutyStatusLogType

ToDate

Gets or sets search for DutyStatusLogs that were recorded at this date or before.

public DateTime? ToDate { get; set; }

Property Value

DateTime?

DateTime

UserSearch

Gets or sets search for DutyStatusLogs with this UserSearch Id. Available UserSearch options are:.

public UserSearch? UserSearch { get; set; }

Property Value

UserSearch

UserSearch

Methods

Clone()

Clone this DutyStatusLogSearch instance.

public override IEntity Clone()

Returns

IEntity

IEntity