Class EntityLinkRule

Namespace

Geotab.Checkmate.ObjectModel.EntityLink

Assembly

Geotab.Checkmate.ObjectModel.dll

A particular instance of an EntityLinkRule.

public class EntityLinkRule : NameEntity, IEntity, IComparable, IIdentifiable, IDefaultable

Inheritance

object

Entity

NameEntity

EntityLinkRule

Implements

IEntity

IComparable

IIdentifiable

IDefaultable

Inherited Members

NameEntity.CompareTo(object)

NameEntity.ToString()

NameEntity.Name

Entity.GetReadOnly()

Entity.Equals(object)

Entity.GetHashCode()

Entity.IsSystemEntity()

Entity.Id

object.GetType()

object.MemberwiseClone()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

EntityLinkRule()

Initializes a new instance of the EntityLinkRule class.

public EntityLinkRule()

EntityLinkRule(Id?)

Initializes a new instance of the EntityLinkRule class.

public EntityLinkRule(Id? id)

Parameters

id Id

The Id.

EntityLinkRule(Id?, string?)

Initializes a new instance of the EntityLinkRule class.

public EntityLinkRule(Id? id, string? name)

Parameters

id Id

The Id.

name string

The name.

EntityLinkRule(Id?, string?, DateTime?, DateTime?, DateTime?, Group?, Group?, EntityLinkRuleConditions?, EntityLinkType?, bool?)

Initializes a new instance of the EntityLinkRule class.

public EntityLinkRule(Id? id, string? name, DateTime? createdDate, DateTime? validFrom, DateTime? validTo, Group? sourceGroup, Group? destinationGroup, EntityLinkRuleConditions? entityLinkRuleConditions, EntityLinkType? entityLinkType, bool? isActive)

Parameters

id Id

The Id.

name string

The name.

createdDate DateTime?

The created date.

validFrom DateTime?

The valid from date.

validTo DateTime?

The valid to date.

sourceGroup Group

The source group.

destinationGroup Group

The destination group.

entityLinkRuleConditions EntityLinkRuleConditions

The entity link rule conditions.

entityLinkType EntityLinkType?

The entity link type.

isActive bool?

If the rule is active.

Properties

Comments

Gets or sets a value indicating the comments on this rule.

public string? Comments { get; set; }

Property Value

string

string The comments.

CreatedDate

Gets or sets a value indicating when the entity link rule was created.

public DateTime? CreatedDate { get; set; }

Property Value

DateTime?

DateTime The created date.

DestinationGroup

Gets or sets the destination group.

public Group? DestinationGroup { get; set; }

Property Value

Group

Group The destination group.

EntityLinkRuleConditions

Gets or sets the conditions for the entity link rule.

public EntityLinkRuleConditions? EntityLinkRuleConditions { get; set; }

Property Value

EntityLinkRuleConditions

EntityLinkRuleConditions The entity link rule conditions.

EntityLinkType

Gets or sets the entity link type.

public EntityLinkType? EntityLinkType { get; set; }

Property Value

EntityLinkType?

EntityLinkType The entity link type.

IsActive

Gets or sets a value indicating this rule is active and will be considered in evaludation.

public bool? IsActive { get; set; }

Property Value

bool?

bool Boolean indicating the rule is active.

Remarks

Only active rules are considered in entity link validations.

IsAutoDetach

Gets or sets a value indicating this rule is enforcing the auto detachment of existing links when a new link is made.

public bool? IsAutoDetach { get; set; }

Property Value

bool?

bool Boolean indicating auto detachment is enabled.

SourceGroup

Gets or sets the source group.

public Group? SourceGroup { get; set; }

Property Value

Group

Group The source group.

ValidFrom

Gets or sets a value indicating the start date the rule is valid from.

public DateTime? ValidFrom { get; set; }

Property Value

DateTime?

DateTime The valid from date.

ValidTo

Gets or sets a value indicating the end date the rule is valid to.

public DateTime? ValidTo { get; set; }

Property Value

DateTime?

DateTime The valid to date.

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.