Class AmountClassGroupLinkRows

User group link table for AmountClass, for MDO item hiding Collection of AmountClassGroupLinkRow. Each element of the collection represents one row in the AmountClassGroupLink table.

Inheritance
Object
NestedPersist
NestedPersistFacade
NestedCollectionPersist
TableRowsBase
AmountClassGroupLinkRows
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class AmountClassGroupLinkRows : TableRowsBase, INestedPersist, IEnumerable<INestedPersist>, ISoCollection, IList, ICollection, IEnumerable, 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 AmountClassGroupLinkRow to it, and use methods like to operate on the whole collection.
  • You can create a (nested) AmountClassGroupLinkRows AmountClassGroupLinkRows.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(AmountClassGroupLinkRows.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 AmountClassGroupLinkRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, AmountClassGroupLinkTableInfo) 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 AmountClassGroupLinkRow given its index in the collection.

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

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

Methods

Add(AmountClassGroupLinkRow)

Add one AmountClassGroupLinkRow to the collection.

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

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

The index of the added AmountClassGroupLinkRow.

AddNew()

Add a new instance of AmountClassGroupLinkRow added to the collection.

Declaration
public AmountClassGroupLinkRow AddNew()
Returns
Type Description
AmountClassGroupLinkRow

A new instance of AmountClassGroupLinkRow added to the collection.

AddRange(IEnumerable<AmountClassGroupLinkRow>)

Add a range of AmountClassGroupLinkRow to the collection.

Declaration
public AmountClassGroupLinkRows AddRange(IEnumerable<AmountClassGroupLinkRow> rows)
Parameters
Type Name Description
IEnumerable<AmountClassGroupLinkRow> rows
Returns
Type Description
AmountClassGroupLinkRows

The updated AmountClassGroupLinkRows collection object.

CreateChild()

Create a new instance of AmountClassGroupLinkRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of AmountClassGroupLinkRow
Overrides

CreateNew()

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

Declaration
public static AmountClassGroupLinkRows CreateNew()
Returns
Type Description
AmountClassGroupLinkRows

A new instance of the AmountClassGroupLinkRows object.

Find(Predicate<AmountClassGroupLinkRow>)

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

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

FindAll(Predicate<AmountClassGroupLinkRow>)

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

Declaration
public AmountClassGroupLinkRows FindAll(Predicate<AmountClassGroupLinkRow> condition)
Parameters
Type Name Description
Predicate<AmountClassGroupLinkRow> condition
Returns
Type Description
AmountClassGroupLinkRows

ForEach(Action<AmountClassGroupLinkRow>)

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

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

GetFromCustomSearch(AmountClassGroupLinkRows.CustomSearch)

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

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

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

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

GetFromIdxAmountclassId(Int32)

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

Declaration
public static AmountClassGroupLinkRows GetFromIdxAmountclassId(int amountclassId)
Parameters
Type Name Description
Int32 amountclassId
Returns
Type Description
AmountClassGroupLinkRows

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

GetFromIdxGroupId(Int32)

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

Declaration
public static AmountClassGroupLinkRows GetFromIdxGroupId(int groupId)
Parameters
Type Name Description
Int32 groupId
Returns
Type Description
AmountClassGroupLinkRows

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

GetFromReader(SoDataReader, AmountClassGroupLinkTableInfo)

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

SoDataReader positioned to a valid database row.
AmountClassGroupLinkTableInfo tableInfo

AmountClassGroupLinkTableInfo 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
AmountClassGroupLinkRows

Remove(AmountClassGroupLinkRow)

Removes the given AmountClassGroupLinkRow from the collection

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

the AmountClassGroupLinkRow to be removed

ToArray()

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

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

EnumUtil.MapEnums<From, To>(From)