Class ShipmentLog

Namespace

Geotab.Checkmate.ObjectModel

Assembly

Geotab.Checkmate.ObjectModel.dll

A ShipmentLog is a record of shipment transported by a specified vehicle for a duration of time.

public class ShipmentLog : EntityWithVersion, IEntity, IComparable, IIdentifiable, IVersion, IHosLog, IDeviceProvider, IDateTimeProvider, IDefaultable

Inheritance

object

Entity

EntityWithVersion

ShipmentLog

Implements

IEntity

IComparable

IIdentifiable

IVersion

IHosLog

IDeviceProvider

IDateTimeProvider

IDefaultable

Inherited Members

EntityWithVersion.Version

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

ShipmentLog()

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

public ShipmentLog()

ShipmentLog(DateTime?, User?, Device?, DateTime?, DateTime?, string?, string?, string?, Id?, long?)

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

public ShipmentLog(DateTime? dateTime, User? driver, Device? device, DateTime? activeFrom, DateTime? activeTo, string? shipperName, string? documentNumber, string? commodity, Id? id = null, long? version = null)

Parameters

dateTime DateTime?

The DateTime the log was created.

driver User

The User who created this log.

device Device

The Device associated with this log.

activeFrom DateTime?

The DateTime the shipment was started.

activeTo DateTime?

The DateTime the shipment was ended.

shipperName string

The name of the shipper.

documentNumber string

The identifier of the shipment document.

commodity string

The commodity shipped.

id Id

The unique Id of the log.

version long?

The version of the entity.

Properties

ActiveFrom

Gets or sets the date the shipment was started. Default [UtcNow].

public DateTime? ActiveFrom { get; set; }

Property Value

DateTime?

DateTime

ActiveTo

Gets or sets the date the shipment was ended. Default [MaxDate].

public DateTime? ActiveTo { get; set; }

Property Value

DateTime?

DateTime

Commodity

Gets or sets the commodity shipped. Maximum length [255] Default [""].

public string? Commodity { get; set; }

Property Value

string

string

DateTime

Gets or sets the date and time the log was created.

public DateTime? DateTime { get; set; }

Property Value

DateTime?

DateTime

Device

Gets or sets the Device associated with this log.

public Device? Device { get; set; }

Property Value

Device

Device

DocumentNumber

Gets or sets the identifier of the shipment document. Default [""].

public string? DocumentNumber { get; set; }

Property Value

string

string

Driver

Gets or sets the User who created this log.

public User? Driver { get; set; }

Property Value

User

User

ShipperName

Gets or sets the name of the shipper. Default [""].

public string? ShipperName { get; set; }

Property Value

string

string

Methods

Clone()

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

public override IEntity Clone()

Returns

IEntity

A new ShipmentLog that is a copy of this instance.

PopulateDefaults()

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

public void PopulateDefaults()