Class GroupSearch

Namespace

Geotab.Checkmate.ObjectModel

Assembly

Geotab.Checkmate.ObjectModel.dll

The object used to specify the arguments when searching for a Group.

public class GroupSearch : Search, IEntity

Inheritance

object

Search

GroupSearch

Implements

IEntity

Derived

DefectSearch

Inherited Members

Search.Clone()

Search.GetReadOnly()

Search.Id

Search.Version

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

GroupSearch()

Initializes a new instance of the GroupSearch class.

public GroupSearch()

GroupSearch(Id?)

Initializes a new instance of the GroupSearch class.

public GroupSearch(Id? id)

Parameters

id Id

The ID.

Properties

Ancestors

Gets or sets search for Groups that are descendants of the group with this Id. The group with this Id would also be included in the result.

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

Property Value

List<GroupSearch>

Id

Remarks

This parameter cannot be combined with any other parameters.

IncludeAllTrees

Gets or sets include Groups from all trees, for example "Security Groups" and "Private User Groups". The"Company Group" tree is included by default.

public bool? IncludeAllTrees { get; set; }

Property Value

bool?

bool

MaxId

Gets or sets gets maximum Id of the search criteria.

public Id? MaxId { get; set; }

Property Value

Id

Id

Name

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

public string? Name { get; set; }

Property Value

string

string

Reference

Gets or sets search for Groups with this Reference. Wildcard can be used by prepending/appending "%" to string. Example "%reference%".

public string? Reference { get; set; }

Property Value

string

string

Methods

GroupSearchsToGroups(ICollection<GroupSearch>?)

Convert a list of GroupSearch by ID into a list of Groups.

public static IList<Group>? GroupSearchsToGroups(ICollection<GroupSearch>? groupSearches)

Parameters

groupSearches ICollection<GroupSearch>

The list of GroupSearches by ID.

Returns

IList<Group>

An array of Groups.

GroupsToGroupSearches(ICollection<Group>?)

Convert a list of Groups by ID into a list of GroupSearch.

public static List<GroupSearch>? GroupsToGroupSearches(ICollection<Group>? groups)

Parameters

groups ICollection<Group>

The list of GroupSearches by ID.

Returns

List<GroupSearch>

An array of GroupSearch.