Class SearchCriterionValueRows

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

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

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

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

Methods

Add(SearchCriterionValueRow)

Add one SearchCriterionValueRow to the collection.

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

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

The index of the added SearchCriterionValueRow.

AddNew()

Add a new instance of SearchCriterionValueRow added to the collection.

Declaration
public SearchCriterionValueRow AddNew()
Returns
Type Description
SearchCriterionValueRow

A new instance of SearchCriterionValueRow added to the collection.

AddRange(IEnumerable<SearchCriterionValueRow>)

Add a range of SearchCriterionValueRow to the collection.

Declaration
public SearchCriterionValueRows AddRange(IEnumerable<SearchCriterionValueRow> rows)
Parameters
Type Name Description
IEnumerable<SearchCriterionValueRow> rows
Returns
Type Description
SearchCriterionValueRows

The updated SearchCriterionValueRows collection object.

CreateChild()

Create a new instance of SearchCriterionValueRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of SearchCriterionValueRow
Overrides

CreateNew()

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

Declaration
public static SearchCriterionValueRows CreateNew()
Returns
Type Description
SearchCriterionValueRows

A new instance of the SearchCriterionValueRows object.

Find(Predicate<SearchCriterionValueRow>)

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

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

FindAll(Predicate<SearchCriterionValueRow>)

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

Declaration
public SearchCriterionValueRows FindAll(Predicate<SearchCriterionValueRow> condition)
Parameters
Type Name Description
Predicate<SearchCriterionValueRow> condition
Returns
Type Description
SearchCriterionValueRows

ForEach(Action<SearchCriterionValueRow>)

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

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

GetFromCustomSearch(SearchCriterionValueRows.CustomSearch)

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

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

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

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

GetFromReader(SoDataReader, SearchCriterionValueTableInfo)

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

SoDataReader positioned to a valid database row.
SearchCriterionValueTableInfo tableInfo

SearchCriterionValueTableInfo 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
SearchCriterionValueRows

Remove(SearchCriterionValueRow)

Removes the given SearchCriterionValueRow from the collection

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

the SearchCriterionValueRow to be removed

ToArray()

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

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)