Class FieldSelector

Namespace

Geotab.Checkmate.ObjectModel

Assembly

Geotab.Checkmate.ObjectModel.dll

An abstract class for different types of field selectors.

public abstract class FieldSelector

Inheritance

object

FieldSelector

Derived

ColumnSelector

PropertySelector

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

FieldSelector()

Initializes a new instance of the FieldSelector class.

protected FieldSelector()

FieldSelector(IEnumerable<string>, bool)

Initializes a new instance of the FieldSelector class.

protected FieldSelector(IEnumerable<string> fields, bool isIncluded)

Parameters

fields IEnumerable<string>

The field names ICollection<T> to include or exclude from the result.

isIncluded bool

A value indicating whether the Fields are to be included or excluded.

Properties

Fields

Gets or sets the collection containing the Entity field names. The system matches those on case-insensitive basis and excludes from the result. Check specific Entity for the fields that can be included or excluded. Undefined or empty collection results in default API behavior: a completely populated object.

public ICollection<string>? Fields { get; set; }

Property Value

ICollection<string>

The ICollection<T> of fields.

IsIncluded

Gets or sets a value indicating whether the specified fields are to be included or excluded. [Default true]

public bool? IsIncluded { get; set; }

Property Value

bool?

true if the Fields are included; otherwise, false.

Methods

Append(string)

Appends a field to the selection.

public virtual void Append(string field)

Parameters

field string

The field.

Includes(string)

Determines whether this instance includes the field name.

public bool Includes(string field)

Parameters

field string

The field name.

Returns

bool

true if includes the specified field; otherwise, false.

Remove(string)

Removes a field from the selection.

public virtual void Remove(string field)

Parameters

field string

The field.