Class ComptrGroupLinkRows

User group link table for Comptr, for MDO item hiding Collection of ComptrGroupLinkRow. Each element of the collection represents one row in the ComptrGroupLink table.

Inheritance
object
NestedPersist
NestedPersistFacade
NestedCollectionPersist
TableRowsBase
ComptrGroupLinkRows
Inherited Members
Namespace: SuperOfficeCRMRows
Assembly: SoDataBase.dll
Syntax
public class ComptrGroupLinkRows : TableRowsBase, INestedPersist, IEnumerable<INestedPersist>, INotifyCollectionChanged, IBindingList, IList, ICollection, IEnumerable
Remarks

Row collections can be created in several ways.

  • Use the static CreateNew() method to create a new, empty collection. You can then add objects of type ComptrGroupLinkRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) ComptrGroupLinkRows ComptrGroupLinkRows.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch method to apply the query to the database and obtain the result as a Rows object, with one item for each table row that matched your query.
  • For each non-unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
Unique indexes are handled through the ComptrGroupLinkRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.ComptrGroupLinkRows.GetFromReader method to retrieve the results of queries that return more than one row (this method will iterate over the reader to fetch ALL results, so beware of fetching huge result sets).

Properties

this[int]

Get a ComptrGroupLinkRow given its index in the collection.

Declaration
public ComptrGroupLinkRow this[int index] { get; }
Parameters
Type Name Description
int index

Index of the ComptrGroupLinkRow in the collection
Property Value
Type Description
ComptrGroupLinkRow

Methods

Add(ComptrGroupLinkRow)

Add one ComptrGroupLinkRow to the collection.

Declaration
public int Add(ComptrGroupLinkRow row)
Parameters
Type Name Description
ComptrGroupLinkRow row

An instance of ComptrGroupLinkRow to be added to the collection.
Returns
Type Description
int

The index of the added ComptrGroupLinkRow.

AddNew()

Add a new instance of ComptrGroupLinkRow added to the collection.

Declaration
public ComptrGroupLinkRow AddNew()
Returns
Type Description
ComptrGroupLinkRow

A new instance of ComptrGroupLinkRow added to the collection.

AddRange(IEnumerable<ComptrGroupLinkRow>)

Add a range of ComptrGroupLinkRow to the collection.

Declaration
public ComptrGroupLinkRows AddRange(IEnumerable<ComptrGroupLinkRow> rows)
Parameters
Type Name Description
IEnumerableComptrGroupLinkRow rows
Returns
Type Description
ComptrGroupLinkRows

The updated ComptrGroupLinkRows collection object.

CreateChild()

Create a new instance of ComptrGroupLinkRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of ComptrGroupLinkRow
Overrides

CreateNew()

Create a new instance of the ComptrGroupLinkRows object. This collection will contain no rows.

Declaration
public static ComptrGroupLinkRows CreateNew()
Returns
Type Description
ComptrGroupLinkRows

A new instance of the ComptrGroupLinkRows object.

Find(Predicate<ComptrGroupLinkRow>)

Apply the predicate to each element of the collection and return the first row that matches; if no match then return null

Declaration
public ComptrGroupLinkRow Find(Predicate<ComptrGroupLinkRow> condition)
Parameters
Type Name Description
PredicateComptrGroupLinkRow condition
Returns
Type Description
ComptrGroupLinkRow

FindAll(Predicate<ComptrGroupLinkRow>)

Return a new collection that contains only those elements that match the condition. Elements are shared, not clones! of the original collection

Declaration
public ComptrGroupLinkRows FindAll(Predicate<ComptrGroupLinkRow> condition)
Parameters
Type Name Description
PredicateComptrGroupLinkRow condition
Returns
Type Description
ComptrGroupLinkRows

ForEach(Action<ComptrGroupLinkRow>)

Method that iterates over all members and applies the action parameter to each of them

Declaration
public void ForEach(Action<ComptrGroupLinkRow> whatToDo)
Parameters
Type Name Description
ActionComptrGroupLinkRow whatToDo

GetFromCustomSearchAsync(CustomSearch, CancellationToken)

Create a new instance of the ComptrGroupLinkRows object, and populate it with data from a custom search. If the search returns no results, an empty collection will be returned; if the result contains rows, a collection of ComptrGroupLinkRow objects representing each row will be returned.

Declaration
public static Task<ComptrGroupLinkRows> GetFromCustomSearchAsync(ComptrGroupLinkRows.CustomSearch query, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ComptrGroupLinkRowsCustomSearch query

The custom search to execute against the database
CancellationToken cancellationToken
Returns
Type Description
TaskComptrGroupLinkRows

A new instance of the ComptrGroupLinkRows object, reflecting the result of the query.

GetFromIdxComptrIdAsync(int, CancellationToken)

Create a new instance of the ComptrGroupLinkRow object, by querying the database table via the index 'IDXComptrGLComptr_id'. This method is intended to make it easy to use efficient queries that match a database index.

Declaration
public static Task<ComptrGroupLinkRows> GetFromIdxComptrIdAsync(int comptrId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int comptrId
CancellationToken cancellationToken
Returns
Type Description
TaskComptrGroupLinkRows

Row object that represents the result of the search. IsNew will be true if the query did not match any row in the table
Remarks

This method represents one of the unique indexes on the ComptrGroupLink table. Non-unique indexes have corresponding inner classes and methods in the ComptrGroupLinkRows collection, since they may return more than one row.

GetFromIdxGroupIdAsync(int, CancellationToken)

Create a new instance of the ComptrGroupLinkRow object, by querying the database table via the index 'IDXComptrGLGroup_id'. This method is intended to make it easy to use efficient queries that match a database index.

Declaration
public static Task<ComptrGroupLinkRows> GetFromIdxGroupIdAsync(int groupId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int groupId
CancellationToken cancellationToken
Returns
Type Description
TaskComptrGroupLinkRows

Row object that represents the result of the search. IsNew will be true if the query did not match any row in the table
Remarks

This method represents one of the unique indexes on the ComptrGroupLink table. Non-unique indexes have corresponding inner classes and methods in the ComptrGroupLinkRows collection, since they may return more than one row.

GetFromReaderAsync(SoDataReader, ComptrGroupLinkTableInfo, CancellationToken)

Create a new instance of the ComptrGroupLinkRows object, and populate it with data from a reader. If the search returns no results, an empty collection will be returned; if the result contains rows, a collection of ComptrGroupLinkRow objects representing each row will be returned.

Note that the internal logic starts by calling reader.Read(), which is correct if you hand the method the result of an ExecuteReader(), but if the reader has already been advanced one or more rows, the current row will be skipped and collection population will start with the next row.

Declaration
public static Task<ComptrGroupLinkRows> GetFromReaderAsync(SoDataReader reader, ComptrGroupLinkTableInfo tableInfo, CancellationToken cancellationToken = default)
Parameters
Type Name Description
SoDataReader reader

SoDataReader positioned to a valid database row.
ComptrGroupLinkTableInfo tableInfo

ComptrGroupLinkTableInfo instance used in the query that is the source of the reader. The fields used from the reader will be those owned by this tableinfo object.
CancellationToken cancellationToken
Returns
Type Description
TaskComptrGroupLinkRows

Remove(ComptrGroupLinkRow)

Removes the given ComptrGroupLinkRow from the collection

Declaration
public void Remove(ComptrGroupLinkRow row)
Parameters
Type Name Description
ComptrGroupLinkRow row

the ComptrGroupLinkRow to be removed

ToArray()

Declaration
public ComptrGroupLinkRow[] ToArray()
Returns
Type Description
ComptrGroupLinkRow

ToString()

For debugging: Number of members, and the first (up to) 5 items

Declaration
public override string ToString()
Returns
Type Description
string
Overrides

Implements

Extension Methods