Class TypicalSearchRows

Owner of a set of predefined selection criteria Collection of TypicalSearchRow. Each element of the collection represents one row in the TypicalSearch table.

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

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

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

Methods

Add(TypicalSearchRow)

Add one TypicalSearchRow to the collection.

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

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

The index of the added TypicalSearchRow.

AddNew()

Add a new instance of TypicalSearchRow added to the collection.

Declaration
public TypicalSearchRow AddNew()
Returns
Type Description
TypicalSearchRow

A new instance of TypicalSearchRow added to the collection.

AddRange(IEnumerable<TypicalSearchRow>)

Add a range of TypicalSearchRow to the collection.

Declaration
public TypicalSearchRows AddRange(IEnumerable<TypicalSearchRow> rows)
Parameters
Type Name Description
IEnumerable<TypicalSearchRow> rows
Returns
Type Description
TypicalSearchRows

The updated TypicalSearchRows collection object.

CreateChild()

Create a new instance of TypicalSearchRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of TypicalSearchRow
Overrides

CreateNew()

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

Declaration
public static TypicalSearchRows CreateNew()
Returns
Type Description
TypicalSearchRows

A new instance of the TypicalSearchRows object.

Find(Predicate<TypicalSearchRow>)

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

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

FindAll(Predicate<TypicalSearchRow>)

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

Declaration
public TypicalSearchRows FindAll(Predicate<TypicalSearchRow> condition)
Parameters
Type Name Description
Predicate<TypicalSearchRow> condition
Returns
Type Description
TypicalSearchRows

ForEach(Action<TypicalSearchRow>)

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

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

GetFromCustomSearch(TypicalSearchRows.CustomSearch)

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

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

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

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

GetFromIdxEntityName(String)

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

Declaration
public static TypicalSearchRows GetFromIdxEntityName(string entityName)
Parameters
Type Name Description
String entityName
Returns
Type Description
TypicalSearchRows

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

GetFromIdxEntityNameSource(String, String)

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

Declaration
public static TypicalSearchRows GetFromIdxEntityNameSource(string entityName, string source)
Parameters
Type Name Description
String entityName
String source
Returns
Type Description
TypicalSearchRows

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

GetFromReader(SoDataReader, TypicalSearchTableInfo)

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

SoDataReader positioned to a valid database row.
TypicalSearchTableInfo tableInfo

TypicalSearchTableInfo 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
TypicalSearchRows

Remove(TypicalSearchRow)

Removes the given TypicalSearchRow from the collection

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

the TypicalSearchRow to be removed

ToArray()

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

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)