Table of Contents

Class RuleSearch

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

true search The object used to specify the arguments when searching for a Rule.

public class RuleSearch : Search, IEntity
Inheritance
RuleSearch
Implements
Inherited Members

Constructors

RuleSearch()

Initializes a new instance of the RuleSearch class.Constructor.

public RuleSearch()

RuleSearch(Id?)

Initializes a new instance of the RuleSearch class.Constructor.

public RuleSearch(Id? id)

Parameters

id Id

Id

Properties

BaseType

Gets or sets search for Rules that are this ExceptionRuleBaseType; either Custom, Stock, or ZoneStop.

public ExceptionRuleBaseType? BaseType { get; set; }

Property Value

ExceptionRuleBaseType?

ExceptionRuleBaseType

Category

Gets or sets search for Rules that are in this ExceptionRuleCategory; either ApplicationExceptionRule, UserExceptionRules or ZoneStopExceptionRules.

public ExceptionRuleCategory? Category { get; set; }

Property Value

ExceptionRuleCategory?

ExceptionRuleCategory

GroupFilterCondition

Gets or sets the groups to find the rules belonging to parents or children of the groups using and/or relationship.

public GroupFilterCondition? GroupFilterCondition { get; set; }

Property Value

GroupFilterCondition

And/or relation between groups to search

Groups

Gets or sets search for Rules that are members of these GroupSearch(s) one of it's children or one of it's parents. Available GroupSearch options are:.

public List<GroupSearch>? Groups { get; set; }

Property Value

List<GroupSearch>

IList<T>

Id

Gets or sets search for a Rule with this Id. Id cannot be used with any other search properties.

public override Id? Id { get; set; }

Property Value

Id

Id

IncludeZoneStopRules

Gets or sets include zone stop rules. Default [false].

public bool? IncludeZoneStopRules { get; set; }

Property Value

bool?

bool

Name

Gets or sets search for Rules with this Name. Wildcard can be used by prepending/appending "%" to string. Example "%comments%".

public string? Name { get; set; }

Property Value

string

string

ZoneTypes

Gets or sets the list of ZoneType to search by.

public List<ZoneType>? ZoneTypes { get; set; }

Property Value

List<ZoneType>

IList<T>