Table of Contents

Class Entity

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

true All objects that are stored in the database are entities. They are uniquely identified by their Id which is used later to Get, modify (Set) or Remove that object. The following entities are supported:

[ReportClass]
public abstract class Entity : IEntity, IComparable, IIdentifiable
Inheritance
Entity
Implements
Derived
Inherited Members

Constructors

Entity()

Initializes a new instance of the Entity class. Initializes a new instance of the Entity class.

protected Entity()

Entity(Entity)

Initializes a new instance of the Entity class. Copy constructor to initializes a new instance of the Entity class.

protected Entity(Entity value)

Parameters

value Entity

The value.

Entity(Id?)

Initializes a new instance of the Entity class. Initializes a new instance of the Entity class.

protected Entity(Id? id)

Parameters

id Id

The unique identifier for this entity. See Id.

Properties

Id

Gets or sets the unique identifier for the specific Entity object in the Geotab system. See Id.

public virtual Id? Id { get; set; }

Property Value

Id

returns. Id

Methods

Clone()

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

public abstract IEntity Clone()

Returns

IEntity

A new object that is a copy of this instance.

CompareTo(object?)

Compares the current instance with another object of the same type.

public virtual int CompareTo(object? obj)

Parameters

obj object

An object to compare with this instance.

Returns

int

A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has these meanings: Value Meaning Less than zero This instance is less than obj. Zero This instance is equal to obj. Greater than zero This instance is greater than obj.

Equals(object?)

Determines whether the specified object, is equal to this instance.

public override bool Equals(object? obj)

Parameters

obj object

The object to compare with this instance.

Returns

bool

true if the specified object is equal to this instance; otherwise, false.

GetHashCode()

Returns a hash code for this instance.

public override int GetHashCode()

Returns

int

A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.

GetReadOnly()

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

public virtual IEntity GetReadOnly()

Returns

IEntity

returns. IEntity

Exceptions

NotSupportedException

Not supported in the base class (overridden in derived classes).

IsSystemEntity()

Returns true if the class is a system entity, false otherwise.

public virtual bool IsSystemEntity()

Returns

bool

true if the entity is a system entity; otherwise, false.

ToString()

Returns a string that represents this instance.

public override string ToString()

Returns

string

A string that represents this instance.