Class SearchCatGroupLinkRows

User group link table for SearchCat, for MDO item hiding Collection of SearchCatGroupLinkRow. Each element of the collection represents one row in the SearchCatGroupLink table.

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

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

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

Methods

Add(SearchCatGroupLinkRow)

Add one SearchCatGroupLinkRow to the collection.

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

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

The index of the added SearchCatGroupLinkRow.

AddNew()

Add a new instance of SearchCatGroupLinkRow added to the collection.

Declaration
public SearchCatGroupLinkRow AddNew()
Returns
Type Description
SearchCatGroupLinkRow

A new instance of SearchCatGroupLinkRow added to the collection.

AddRange(IEnumerable<SearchCatGroupLinkRow>)

Add a range of SearchCatGroupLinkRow to the collection.

Declaration
public SearchCatGroupLinkRows AddRange(IEnumerable<SearchCatGroupLinkRow> rows)
Parameters
Type Name Description
IEnumerable<SearchCatGroupLinkRow> rows
Returns
Type Description
SearchCatGroupLinkRows

The updated SearchCatGroupLinkRows collection object.

CreateChild()

Create a new instance of SearchCatGroupLinkRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of SearchCatGroupLinkRow
Overrides

CreateNew()

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

Declaration
public static SearchCatGroupLinkRows CreateNew()
Returns
Type Description
SearchCatGroupLinkRows

A new instance of the SearchCatGroupLinkRows object.

Find(Predicate<SearchCatGroupLinkRow>)

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

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

FindAll(Predicate<SearchCatGroupLinkRow>)

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

Declaration
public SearchCatGroupLinkRows FindAll(Predicate<SearchCatGroupLinkRow> condition)
Parameters
Type Name Description
Predicate<SearchCatGroupLinkRow> condition
Returns
Type Description
SearchCatGroupLinkRows

ForEach(Action<SearchCatGroupLinkRow>)

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

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

GetFromCustomSearch(SearchCatGroupLinkRows.CustomSearch)

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

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

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

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

GetFromIdxGroupId(Int32)

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

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

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

GetFromIdxSearchCatId(Int32)

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

Declaration
public static SearchCatGroupLinkRows GetFromIdxSearchCatId(int searchCatId)
Parameters
Type Name Description
Int32 searchCatId
Returns
Type Description
SearchCatGroupLinkRows

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

GetFromReader(SoDataReader, SearchCatGroupLinkTableInfo)

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

SoDataReader positioned to a valid database row.
SearchCatGroupLinkTableInfo tableInfo

SearchCatGroupLinkTableInfo 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
SearchCatGroupLinkRows

Remove(SearchCatGroupLinkRow)

Removes the given SearchCatGroupLinkRow from the collection

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

the SearchCatGroupLinkRow to be removed

ToArray()

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

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)