Class DataModeType

Namespace

Geotab.Checkmate.ObjectModel

Assembly

Geotab.Checkmate.ObjectModel.dll

A unique identifier for different types of DataModeTypes. The DataModeType type can be one of the following "Unknown", "Public", "Private", or "PrivateStrict". It is for use with RestrictedDataModeChange only.

public abstract class DataModeType : NameEntity, IEntity, IComparable, IIdentifiable

Inheritance

object

Entity

NameEntity

DataModeType

Implements

IEntity

IComparable

IIdentifiable

Derived

RestrictedDataModeType

UnknownRestrictedDataModeType

UnrestrictedDataModeType

UserRestrictedDataModeType

Inherited Members

NameEntity.CompareTo(object)

NameEntity.ToString()

Entity.Clone()

Entity.GetReadOnly()

Entity.Equals(object)

Entity.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

DataModeType()

Initializes a new instance of the DataModeType class.

protected DataModeType()

DataModeType(Id?, string?)

Initializes a new instance of the DataModeType class.

protected DataModeType(Id? id, string? name)

Parameters

id Id

The Id.

name string

The name.

Properties

Id

Gets or sets the unique identifier for this entity. See Id.

public override Id? Id { get; set; }

Property Value

Id

Id

Name

Gets or sets the name of this entity which identifies it and is used when displaying this entity.

public override string? Name { get; set; }

Property Value

string

string

Methods

DataModeTypeFromDbItype(long)

Returns a DataModeType from the provided long id value else Unknown if it is not an existing DataModeType id.

public static DataModeType DataModeTypeFromDbItype(long id)

Parameters

id long

The id.

Returns

DataModeType

The DataModeType.

DataModeTypeFromId(Id?)

Returns a DataModeType from the provided Id else Unknown if it is not an existing DataModeType id.

public static DataModeType DataModeTypeFromId(Id? id)

Parameters

id Id

The id.

Returns

DataModeType

The DataModeType.

IsPrivate()

Gets a value indicating whether the privacy mode is private.

public bool IsPrivate()

Returns

bool

True if the privacy type is private.

IsPublic()

Gets a value indicating whether the privacy mode is public.

public bool IsPublic()

Returns

bool

True if the privacy type is public.

IsStrict()

Gets a value indicating whether the privacy mode is private strict.

public bool IsStrict()

Returns

bool

True if the privacy type is private strict.

IsSystemEntity()

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

public override bool IsSystemEntity()

Returns

bool

True if the entity is a system entity.

Normalize()

Gets the normalized privacy type.

public DataModeType Normalize()

Returns

DataModeType

The normalized privacy type