Class SearchCriterionRows

Criteria storage for Selection and other Find mechanisms Collection of SearchCriterionRow. Each element of the collection represents one row in the SearchCriterion table.

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

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

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

Methods

Add(SearchCriterionRow)

Add one SearchCriterionRow to the collection.

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

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

The index of the added SearchCriterionRow.

AddNew()

Add a new instance of SearchCriterionRow added to the collection.

Declaration
public SearchCriterionRow AddNew()
Returns
Type Description
SearchCriterionRow

A new instance of SearchCriterionRow added to the collection.

AddRange(IEnumerable<SearchCriterionRow>)

Add a range of SearchCriterionRow to the collection.

Declaration
public SearchCriterionRows AddRange(IEnumerable<SearchCriterionRow> rows)
Parameters
Type Name Description
IEnumerable<SearchCriterionRow> rows
Returns
Type Description
SearchCriterionRows

The updated SearchCriterionRows collection object.

CreateChild()

Create a new instance of SearchCriterionRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of SearchCriterionRow
Overrides

CreateNew()

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

Declaration
public static SearchCriterionRows CreateNew()
Returns
Type Description
SearchCriterionRows

A new instance of the SearchCriterionRows object.

Find(Predicate<SearchCriterionRow>)

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

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

FindAll(Predicate<SearchCriterionRow>)

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

Declaration
public SearchCriterionRows FindAll(Predicate<SearchCriterionRow> condition)
Parameters
Type Name Description
Predicate<SearchCriterionRow> condition
Returns
Type Description
SearchCriterionRows

ForEach(Action<SearchCriterionRow>)

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

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

GetFromCustomSearch(SearchCriterionRows.CustomSearch)

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

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

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

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

GetFromReader(SoDataReader, SearchCriterionTableInfo)

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

SoDataReader positioned to a valid database row.
SearchCriterionTableInfo tableInfo

SearchCriterionTableInfo 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
SearchCriterionRows

Remove(SearchCriterionRow)

Removes the given SearchCriterionRow from the collection

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

the SearchCriterionRow to be removed

ToArray()

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

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)