Class AssociateGroupLinkRows

User group link table for Associate, for MDO item hiding Collection of AssociateGroupLinkRow. Each element of the collection represents one row in the AssociateGroupLink table.

Inheritance
System.Object
NestedPersist
NestedPersistFacade
NestedCollectionPersist
TableRowsBase
AssociateGroupLinkRows
Implements
System.Collections.Generic.IEnumerable<INestedPersist>
System.Collections.IEnumerable
System.Collections.IList
System.Collections.ICollection
System.Collections.Specialized.INotifyCollectionChanged
System.ComponentModel.IBindingList
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class AssociateGroupLinkRows : TableRowsBase, INestedPersist, IEnumerable<INestedPersist>, ISoCollection, IEnumerable, IList, ICollection, INotifyCollectionChanged, IBindingList
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 AssociateGroupLinkRow to it, and use methods like to operate on the whole collection.
  • You can create a (nested) AssociateGroupLinkRows AssociateGroupLinkRows.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(AssociateGroupLinkRows.CustomSearch) 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 AssociateGroupLinkRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, AssociateGroupLinkTableInfo) 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

Item[Int32]

Get a AssociateGroupLinkRow given its index in the collection.

Declaration
public AssociateGroupLinkRow this[int index] { get; }
Parameters
Type Name Description
System.Int32 index

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

Methods

Add(AssociateGroupLinkRow)

Add one AssociateGroupLinkRow to the collection.

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

An instance of AssociateGroupLinkRow to be added to the collection.
Returns
Type Description
System.Int32

The index of the added AssociateGroupLinkRow.

AddNew()

Add a new instance of AssociateGroupLinkRow added to the collection.

Declaration
public AssociateGroupLinkRow AddNew()
Returns
Type Description
AssociateGroupLinkRow

A new instance of AssociateGroupLinkRow added to the collection.

AddRange(IEnumerable<AssociateGroupLinkRow>)

Add a range of AssociateGroupLinkRow to the collection.

Declaration
public AssociateGroupLinkRows AddRange(IEnumerable<AssociateGroupLinkRow> rows)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<AssociateGroupLinkRow> rows
Returns
Type Description
AssociateGroupLinkRows

The updated AssociateGroupLinkRows collection object.

CreateChild()

Create a new instance of AssociateGroupLinkRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of AssociateGroupLinkRow
Overrides

CreateNew()

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

Declaration
public static AssociateGroupLinkRows CreateNew()
Returns
Type Description
AssociateGroupLinkRows

A new instance of the AssociateGroupLinkRows object.

Find(Predicate<AssociateGroupLinkRow>)

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

Declaration
public AssociateGroupLinkRow Find(Predicate<AssociateGroupLinkRow> condition)
Parameters
Type Name Description
System.Predicate<AssociateGroupLinkRow> condition
Returns
Type Description
AssociateGroupLinkRow

FindAll(Predicate<AssociateGroupLinkRow>)

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

Declaration
public AssociateGroupLinkRows FindAll(Predicate<AssociateGroupLinkRow> condition)
Parameters
Type Name Description
System.Predicate<AssociateGroupLinkRow> condition
Returns
Type Description
AssociateGroupLinkRows

ForEach(Action<AssociateGroupLinkRow>)

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

Declaration
public void ForEach(Action<AssociateGroupLinkRow> whatToDo)
Parameters
Type Name Description
System.Action<AssociateGroupLinkRow> whatToDo

GetFromCustomSearch(AssociateGroupLinkRows.CustomSearch)

Create a new instance of the AssociateGroupLinkRows 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 AssociateGroupLinkRow objects representing each row will be returned.

Declaration
public static AssociateGroupLinkRows GetFromCustomSearch(AssociateGroupLinkRows.CustomSearch query)
Parameters
Type Name Description
AssociateGroupLinkRows.CustomSearch query

The custom search to execute against the database
Returns
Type Description
AssociateGroupLinkRows

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

GetFromIdxAssociateId(Int32)

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

Declaration
public static AssociateGroupLinkRows GetFromIdxAssociateId(int associateId)
Parameters
Type Name Description
System.Int32 associateId
Returns
Type Description
AssociateGroupLinkRows

Row object that represents the result of the search. 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 AssociateGroupLink table. Non-unique indexes have corresponding inner classes and methods in the AssociateGroupLinkRows collection, since they may return more than one row.

GetFromIdxGroupId(Int32)

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

Declaration
public static AssociateGroupLinkRows GetFromIdxGroupId(int groupId)
Parameters
Type Name Description
System.Int32 groupId
Returns
Type Description
AssociateGroupLinkRows

Row object that represents the result of the search. 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 AssociateGroupLink table. Non-unique indexes have corresponding inner classes and methods in the AssociateGroupLinkRows collection, since they may return more than one row.

GetFromReader(SoDataReader, AssociateGroupLinkTableInfo)

Create a new instance of the AssociateGroupLinkRows 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 AssociateGroupLinkRow 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 AssociateGroupLinkRows GetFromReader(SoDataReader reader, AssociateGroupLinkTableInfo tableInfo)
Parameters
Type Name Description
SoDataReader reader

SoDataReader positioned to a valid database row.
AssociateGroupLinkTableInfo tableInfo

AssociateGroupLinkTableInfo 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.
Returns
Type Description
AssociateGroupLinkRows

Remove(AssociateGroupLinkRow)

Removes the given AssociateGroupLinkRow from the collection

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

the AssociateGroupLinkRow to be removed

ToArray()

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

ToString()

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

Declaration
public override string ToString()
Returns
Type Description
System.String

Implements

System.Collections.Generic.IEnumerable<>
System.Collections.IEnumerable
System.Collections.IList
System.Collections.ICollection
System.Collections.Specialized.INotifyCollectionChanged
System.ComponentModel.IBindingList

Extension Methods

EnumUtil.MapEnums<From, To>(From)