Class IntentGroupLinkRows

User group link table for Intent, for MDO item hiding Collection of IntentGroupLinkRow. Each element of the collection represents one row in the IntentGroupLink table.

Inheritance
System.Object
NestedPersist
NestedPersistFacade
NestedCollectionPersist
TableRowsBase
IntentGroupLinkRows
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 IntentGroupLinkRows : 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 IntentGroupLinkRow to it, and use methods like to operate on the whole collection.
  • You can create a (nested) IntentGroupLinkRows IntentGroupLinkRows.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(IntentGroupLinkRows.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 IntentGroupLinkRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, IntentGroupLinkTableInfo) 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 IntentGroupLinkRow given its index in the collection.

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

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

Methods

Add(IntentGroupLinkRow)

Add one IntentGroupLinkRow to the collection.

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

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

The index of the added IntentGroupLinkRow.

AddNew()

Add a new instance of IntentGroupLinkRow added to the collection.

Declaration
public IntentGroupLinkRow AddNew()
Returns
Type Description
IntentGroupLinkRow

A new instance of IntentGroupLinkRow added to the collection.

AddRange(IEnumerable<IntentGroupLinkRow>)

Add a range of IntentGroupLinkRow to the collection.

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

The updated IntentGroupLinkRows collection object.

CreateChild()

Create a new instance of IntentGroupLinkRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of IntentGroupLinkRow
Overrides

CreateNew()

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

Declaration
public static IntentGroupLinkRows CreateNew()
Returns
Type Description
IntentGroupLinkRows

A new instance of the IntentGroupLinkRows object.

Find(Predicate<IntentGroupLinkRow>)

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

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

FindAll(Predicate<IntentGroupLinkRow>)

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

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

ForEach(Action<IntentGroupLinkRow>)

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

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

GetFromCustomSearch(IntentGroupLinkRows.CustomSearch)

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

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

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

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

GetFromIdxGroupId(Int32)

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

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

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 IntentGroupLink table. Non-unique indexes have corresponding inner classes and methods in the IntentGroupLinkRows collection, since they may return more than one row.

GetFromIdxIntentId(Int32)

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

Declaration
public static IntentGroupLinkRows GetFromIdxIntentId(int intentId)
Parameters
Type Name Description
System.Int32 intentId
Returns
Type Description
IntentGroupLinkRows

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 IntentGroupLink table. Non-unique indexes have corresponding inner classes and methods in the IntentGroupLinkRows collection, since they may return more than one row.

GetFromReader(SoDataReader, IntentGroupLinkTableInfo)

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

SoDataReader positioned to a valid database row.
IntentGroupLinkTableInfo tableInfo

IntentGroupLinkTableInfo 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
IntentGroupLinkRows

Remove(IntentGroupLinkRow)

Removes the given IntentGroupLinkRow from the collection

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

the IntentGroupLinkRow to be removed

ToArray()

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

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)