Class DeviceReprocessRequest

Namespace

Geotab.Checkmate.ObjectModel.Reprocessing

Assembly

Geotab.Checkmate.ObjectModel.dll

Represents a request to reprocess data for a specific device.

public class DeviceReprocessRequest : Entity, IEntity, IComparable, IIdentifiable, IDateTimeProvider, IDeviceProvider

Inheritance

object

Entity

DeviceReprocessRequest

Implements

IEntity

IComparable

IIdentifiable

IDateTimeProvider

IDeviceProvider

Inherited Members

Entity.GetReadOnly()

Entity.CompareTo(object)

Entity.Equals(object)

Entity.GetHashCode()

Entity.IsSystemEntity()

Entity.ToString()

Entity.Id

object.GetType()

object.MemberwiseClone()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Remarks

See also ReprocessRequest

Constructors

DeviceReprocessRequest()

Initializes a new instance of the DeviceReprocessRequest class.

public DeviceReprocessRequest()

DeviceReprocessRequest(Device, DateTime?, bool)

Initializes a new instance of the DeviceReprocessRequest class.

public DeviceReprocessRequest(Device device, DateTime? fromDate, bool isCompleteReprocess = true)

Parameters

device Device

The device for which data will be reprocessed.

fromDate DateTime?

Data from this date forward will be reprocessed.

isCompleteReprocess bool

If true then all data will be reprocessed. If false then only rules will be re-evaluated.

DeviceReprocessRequest(Id?, Device?, DateTime?, IList<Id>?, ReprocessRequestStatus?)

Initializes a new instance of the DeviceReprocessRequest class.

public DeviceReprocessRequest(Id? reprocessRequestId, Device? device, DateTime? fromDate, IList<Id>? ruleIds, ReprocessRequestStatus? status)

Parameters

reprocessRequestId Id

The Id that uniquely identifies the parent ReprocessRequest.

device Device

The device for which data will be reprocessed.

fromDate DateTime?

Data from this date forward will be reprocessed.

ruleIds IList<Id>

A list Id of Rules to re-evaluate.

status ReprocessRequestStatus?

The current ReprocessRequestStatus of the request.

Properties

DateTime

Gets the FromDate. Required by IDateTimeProvider. See FromDate.

public DateTime? DateTime { get; }

Property Value

DateTime?

The FromDate.

Device

Gets or sets the device for which data will be reprocessed.

public Device? Device { get; set; }

Property Value

Device

The device for which data will be reprocessed.

FromDate

Gets or sets a value indicating the cutoff date for reprocssing.

public DateTime? FromDate { get; set; }

Property Value

DateTime?

Data from this date forward will be reprocessed.

IsComplete

Gets a value indicating whether this request is in a terminal state.

public bool IsComplete { get; }

Property Value

bool

true if this request in a terminal state, otherwise false.

IsCompleteReprocess

Gets a value indicating whether all data will be reprocessed. If true then all data will be reprocessed. If false then only rules will be re-evaluated.

public bool IsCompleteReprocess { get; }

Property Value

bool

Indicates what data to reprocess

ReprocessRequestId

Gets or sets the Id that uniquely identifies the parent ReprocessRequest.

public Id? ReprocessRequestId { get; set; }

Property Value

Id

The Id that uniquely identifies the parent ReprocessRequest.

RuleIds

Gets or sets the list of Rule Ids to re-evaluate. If left blank, rules will not be re-evaluated, and existing exceptions will not be modified.

public IList<Id>? RuleIds { get; set; }

Property Value

IList<Id>

The list of Rule Ids to re-evaluate.

Remarks

See also AllRulesIdReprocessRequest.

Status

Gets or sets a value representing the current status of the DeviceReprocessRequest.

public ReprocessRequestStatus? Status { get; set; }

Property Value

ReprocessRequestStatus?

The current status of the DeviceReprocessRequest.

StatusText

Gets or sets additional information regarding the current status of the DeviceReprocessRequest.

public string? StatusText { get; set; }

Property Value

string

Additional information regarding the current status of the DeviceReprocessRequest.

Methods

Clone()

Creates a new object that is a copy of the current instance.

public override IEntity Clone()

Returns

IEntity

A new object that is a copy of this instance.