Table of Contents

Class ReprocessRequest

Namespace
Geotab.Checkmate.ObjectModel.Reprocessing
Assembly
Geotab.Checkmate.ObjectModel.dll

Represents a request to reprocess data for one or more devices.

public class ReprocessRequest : Entity, IEntity, IComparable, IIdentifiable, IDateTimeProvider
Inheritance
ReprocessRequest
Implements
Inherited Members

Remarks

See also DeviceReprocessRequest

Constructors

ReprocessRequest()

Initializes a new instance of the ReprocessRequest class.

public ReprocessRequest()

ReprocessRequest(Device, in DateTime, bool)

Initializes a new instance of the ReprocessRequest class.

public ReprocessRequest(Device device, in DateTime fromDate, bool isCompleteReprocess = false)

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.

ReprocessRequest(Device, in DateTime, IList<Id>?)

Initializes a new instance of the ReprocessRequest class.

public ReprocessRequest(Device device, in DateTime fromDate, IList<Id>? ruleIds = null)

Parameters

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.

ReprocessRequest(in DateTime, DeviceSearch, IList<Id>?)

Initializes a new instance of the ReprocessRequest class.

public ReprocessRequest(in DateTime fromDate, DeviceSearch deviceSearchFilter, IList<Id>? ruleIds)

Parameters

fromDate DateTime

Data from this date forward will be reprocessed.

deviceSearchFilter DeviceSearch

A logical group filter used to specify the devices that are included in this reprocess requset.

ruleIds IList<Id>

A list Id of Rules to re-evaluate.

ReprocessRequest(in DateTime, FilterType, IList<Id>?, IList<Id>?)

Initializes a new instance of the ReprocessRequest class.

public ReprocessRequest(in DateTime fromDate, FilterType deviceFilterType, IList<Id>? deviceFilterIds, IList<Id>? ruleIds)

Parameters

fromDate DateTime

Data from this date forward will be reprocessed.

deviceFilterType FilterType

Describes the type of filter used to identify the Devices that this ReprocessRequest applies to.

deviceFilterIds IList<Id>

List of Ids that represent a filter that can be resolves to a list of Devices. How these Ids are resolved depends on the FilterType.

ruleIds IList<Id>

A list Id of Rules to re-evaluate.

Properties

DateTime

Gets the DateTime. Required by IDateTimeProvider.

public DateTime? DateTime { get; }

Property Value

DateTime?

The DateTime.

DeviceFilterIds

Gets or sets the list of Ids that represent a filter that can be resolved to a list of Devices. How these Ids are resolved depends on the FilterType.

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

Property Value

IList<Id>

The list of Ids to use in the DeviceFilter

Remarks

See also IReprocessRequestDeviceFilter.

Mutually exclusive with DeviceSearchFilter.

DeviceFilterType

Gets or sets a value indicating the type of filter used to identify the Devices that this ReprocessRequest applies to.

public FilterType? DeviceFilterType { get; set; }

Property Value

FilterType?

The type of DeviceFilter.

DeviceSearchFilter

Gets or sets the logical groups filter that can be resolved to a list of Devices.

public DeviceSearch? DeviceSearchFilter { get; set; }

Property Value

DeviceSearch

The DeviceSearch to use in the DeviceFilter

Remarks

Mutually exclusive with DeviceFilterIds.

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.

RequestedBy

Gets or sets a value indicating the user who requested the reprocess.

public string? RequestedBy { get; set; }

Property Value

string

The user who requested the reprocess.

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 if Rules to reprocess.

Remarks

See also AllRulesIdReprocessRequest.

Status

Gets or sets a value describes the current status of the Reprocess Request as a whole.

public ReprocessRequestStatus? Status { get; set; }

Property Value

ReprocessRequestStatus?

A status indicating the status of the Reprocess Request.

StatusText

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

public string? StatusText { get; set; }

Property Value

string

Additional information regarding the current status of the ReprocessRequest.

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.