Class DeviceRegistrationState

Namespace

Geotab.Checkmate.ObjectModel.DeviceRegistration

Assembly

Geotab.Checkmate.ObjectModel.dll

A particular instance of an DeviceRegistrationState.

public class DeviceRegistrationState : Entity, IEntity, IComparable, IIdentifiable, IDefaultable

Inheritance

object

Entity

DeviceRegistrationState

Implements

IEntity

IComparable

IIdentifiable

IDefaultable

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)

Constructors

DeviceRegistrationState()

Initializes a new instance of the DeviceRegistrationState class.

public DeviceRegistrationState()

DeviceRegistrationState(Id?)

Initializes a new instance of the DeviceRegistrationState class.

public DeviceRegistrationState(Id? id)

Parameters

id Id

The Id.

DeviceRegistrationState(Id?, Id?, int?, Jurisdiction?, DateTime?, RegistrationStatus?, RegistrationStatus?, string?, string?, bool?)

Initializes a new instance of the DeviceRegistrationState class.

public DeviceRegistrationState(Id? id, Id? deviceId, int? hardwareId, Jurisdiction? jurisdiction, DateTime? createdDate, RegistrationStatus? intendedState, RegistrationStatus? actualState, string? exceptionType, string? exceptionMessage, bool? isCurrent)

Parameters

id Id

The serial internal ID.

deviceId Id

The device ID.

hardwareId int?

The hardware ID.

jurisdiction Jurisdiction?

The jurisdiction.

createdDate DateTime?

The record creation date and time.

intendedState RegistrationStatus?

The intended registration state.

actualState RegistrationStatus?

The actual registration state.

exceptionType string

The exception type.

exceptionMessage string

The exception message.

isCurrent bool?

The flag indicating this is the current record.

Properties

ActualState

Gets or sets the actual registration state.

public RegistrationStatus? ActualState { get; set; }

Property Value

RegistrationStatus?

RegistrationStatus The actual registration state.

Remarks

MyG and GW agreed status.

CreatedDate

Gets or sets the record creation date time.

public DateTime? CreatedDate { get; set; }

Property Value

DateTime?

DateTime The record creation date time.

DeviceId

Gets or sets the device ID.

public Id? DeviceId { get; set; }

Property Value

Id

Id The device ID.

ExceptionMessage

Gets or sets the exception message.

public string? ExceptionMessage { get; set; }

Property Value

string

string The exception message.

ExceptionType

Gets or sets the exception type.

public string? ExceptionType { get; set; }

Property Value

string

string The exception type.

HardwareId

Gets or sets the hardware ID.

public int? HardwareId { get; set; }

Property Value

int?

int The hardware ID.

IntendedState

Gets or sets the intended registration state.

public RegistrationStatus? IntendedState { get; set; }

Property Value

RegistrationStatus?

RegistrationStatus The intended registration state.

Remarks

MyG's intention.

IsCurrent

Gets or sets the flag indicating this record is the most recent, compared to historical records held in the table.

public bool? IsCurrent { get; set; }

Property Value

bool?

bool The indicating flag.

Jurisdiction

Gets or sets the jurisdiction.

public Jurisdiction? Jurisdiction { get; set; }

Property Value

Jurisdiction?

Jurisdiction The jurisdiction.

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.

PopulateDefaults()

Populate non-required empty (null) properties with default values.

public void PopulateDefaults()

Remarks

Consider cases in data migration where the created date will already be populated. In normal production scenarios this object should get the value auto-generated here.