Class SearchCriteriaRows

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

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

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

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

Methods

Add(SearchCriteriaRow)

Add one SearchCriteriaRow to the collection.

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

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

The index of the added SearchCriteriaRow.

AddNew()

Add a new instance of SearchCriteriaRow added to the collection.

Declaration
public SearchCriteriaRow AddNew()
Returns
Type Description
SearchCriteriaRow

A new instance of SearchCriteriaRow added to the collection.

AddRange(IEnumerable<SearchCriteriaRow>)

Add a range of SearchCriteriaRow to the collection.

Declaration
public SearchCriteriaRows AddRange(IEnumerable<SearchCriteriaRow> rows)
Parameters
Type Name Description
IEnumerable<SearchCriteriaRow> rows
Returns
Type Description
SearchCriteriaRows

The updated SearchCriteriaRows collection object.

CreateChild()

Create a new instance of SearchCriteriaRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of SearchCriteriaRow
Overrides

CreateNew()

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

Declaration
public static SearchCriteriaRows CreateNew()
Returns
Type Description
SearchCriteriaRows

A new instance of the SearchCriteriaRows object.

Find(Predicate<SearchCriteriaRow>)

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

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

FindAll(Predicate<SearchCriteriaRow>)

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

Declaration
public SearchCriteriaRows FindAll(Predicate<SearchCriteriaRow> condition)
Parameters
Type Name Description
Predicate<SearchCriteriaRow> condition
Returns
Type Description
SearchCriteriaRows

ForEach(Action<SearchCriteriaRow>)

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

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

GetFromCustomSearch(SearchCriteriaRows.CustomSearch)

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

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

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

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

GetFromIdxOwnerId(Int32)

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

Declaration
public static SearchCriteriaRows GetFromIdxOwnerId(int ownerId)
Parameters
Type Name Description
Int32 ownerId
Returns
Type Description
SearchCriteriaRows

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

GetFromIdxOwnerIdOwnerName(Int32, String)

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

Declaration
public static SearchCriteriaRows GetFromIdxOwnerIdOwnerName(int ownerId, string ownerName)
Parameters
Type Name Description
Int32 ownerId
String ownerName
Returns
Type Description
SearchCriteriaRows

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

GetFromIdxOwnerIdOwnerNameOwnerGuiName(Int32, String, String)

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

Declaration
public static SearchCriteriaRows GetFromIdxOwnerIdOwnerNameOwnerGuiName(int ownerId, string ownerName, string ownerGuiName)
Parameters
Type Name Description
Int32 ownerId
String ownerName
String ownerGuiName
Returns
Type Description
SearchCriteriaRows

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

GetFromIdxOwnerIdOwnerTable(Int32, Int16)

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

Declaration
public static SearchCriteriaRows GetFromIdxOwnerIdOwnerTable(int ownerId, short ownerTable)
Parameters
Type Name Description
Int32 ownerId
Int16 ownerTable
Returns
Type Description
SearchCriteriaRows

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

GetFromIdxOwnerIdOwnerTableOwnerType(Int32, Int16, Int16)

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

Declaration
public static SearchCriteriaRows GetFromIdxOwnerIdOwnerTableOwnerType(int ownerId, short ownerTable, short ownerType)
Parameters
Type Name Description
Int32 ownerId
Int16 ownerTable
Int16 ownerType
Returns
Type Description
SearchCriteriaRows

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

GetFromIdxOwnerIdOwnerTableOwnerTypeOwnerGuiName(Int32, Int16, Int16, String)

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

Declaration
public static SearchCriteriaRows GetFromIdxOwnerIdOwnerTableOwnerTypeOwnerGuiName(int ownerId, short ownerTable, short ownerType, string ownerGuiName)
Parameters
Type Name Description
Int32 ownerId
Int16 ownerTable
Int16 ownerType
String ownerGuiName
Returns
Type Description
SearchCriteriaRows

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

GetFromReader(SoDataReader, SearchCriteriaTableInfo)

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

SoDataReader positioned to a valid database row.
SearchCriteriaTableInfo tableInfo

SearchCriteriaTableInfo 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
SearchCriteriaRows

Remove(SearchCriteriaRow)

Removes the given SearchCriteriaRow from the collection

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

the SearchCriteriaRow to be removed

ToArray()

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

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)