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
Implements
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class SearchCriteriaRows : TableRowsBase, INestedPersist, IEnumerable<INestedPersist>, INotifyCollectionChanged, IBindingList, IList, ICollection, IEnumerable
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 Save 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 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.
Properties
this[int]
Get a SearchCriteriaRow given its index in the collection.
Declaration
public SearchCriteriaRow this[int index] { get; }
Parameters
| Type | Name | Description |
|---|---|---|
| int | index | Index of the SearchCriteriaRow in the collection |
Property Value
| Type | Description |
|---|---|
| SearchCriteriaRow |
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 Save 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 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.
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 |
|---|---|
| int | The index of the added SearchCriteriaRow. |
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 Save 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 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.
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. |
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 Save 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 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.
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. |
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 Save 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 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.
CreateChild()
Create a new instance of SearchCriteriaRow
Declaration
protected override TableRowBase CreateChild()
Returns
| Type | Description |
|---|---|
| TableRowBase | New instance of SearchCriteriaRow |
Overrides
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 Save 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 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.
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. |
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 Save 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 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.
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 |
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 Save 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 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.
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 |
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 Save 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 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.
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 |
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 Save 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 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.
GetFromCustomSearchAsync(CustomSearch, CancellationToken)
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 Task<SearchCriteriaRows> GetFromCustomSearchAsync(SearchCriteriaRows.CustomSearch query, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| SearchCriteriaRows.CustomSearch | query | The custom search to execute against the database |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<SearchCriteriaRows> | A new instance of the SearchCriteriaRows object, reflecting the result of the query. |
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 Save 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 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.
GetFromIdxOwnerIdAsync(int, CancellationToken)
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 Task<SearchCriteriaRows> GetFromIdxOwnerIdAsync(int ownerId, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| int | ownerId | |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<SearchCriteriaRows> | Row object that represents the result of the search. IsNew 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.
GetFromIdxOwnerIdOwnerNameAsync(int, string, CancellationToken)
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 Task<SearchCriteriaRows> GetFromIdxOwnerIdOwnerNameAsync(int ownerId, string ownerName, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| int | ownerId | |
| string | ownerName | |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<SearchCriteriaRows> | Row object that represents the result of the search. IsNew 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.
GetFromIdxOwnerIdOwnerNameOwnerGuiNameAsync(int, string, string, CancellationToken)
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 Task<SearchCriteriaRows> GetFromIdxOwnerIdOwnerNameOwnerGuiNameAsync(int ownerId, string ownerName, string ownerGuiName, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| int | ownerId | |
| string | ownerName | |
| string | ownerGuiName | |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<SearchCriteriaRows> | Row object that represents the result of the search. IsNew 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.
GetFromIdxOwnerIdOwnerTableAsync(int, short, CancellationToken)
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 Task<SearchCriteriaRows> GetFromIdxOwnerIdOwnerTableAsync(int ownerId, short ownerTable, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| int | ownerId | |
| short | ownerTable | |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<SearchCriteriaRows> | Row object that represents the result of the search. IsNew 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.
GetFromIdxOwnerIdOwnerTableOwnerTypeAsync(int, short, short, CancellationToken)
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 Task<SearchCriteriaRows> GetFromIdxOwnerIdOwnerTableOwnerTypeAsync(int ownerId, short ownerTable, short ownerType, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| int | ownerId | |
| short | ownerTable | |
| short | ownerType | |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<SearchCriteriaRows> | Row object that represents the result of the search. IsNew 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.
GetFromIdxOwnerIdOwnerTableOwnerTypeOwnerGuiNameAsync(int, short, short, string, CancellationToken)
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 Task<SearchCriteriaRows> GetFromIdxOwnerIdOwnerTableOwnerTypeOwnerGuiNameAsync(int ownerId, short ownerTable, short ownerType, string ownerGuiName, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| int | ownerId | |
| short | ownerTable | |
| short | ownerType | |
| string | ownerGuiName | |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<SearchCriteriaRows> | Row object that represents the result of the search. IsNew 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.
GetFromReaderAsync(SoDataReader, SearchCriteriaTableInfo, CancellationToken)
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 Task<SearchCriteriaRows> GetFromReaderAsync(SoDataReader reader, SearchCriteriaTableInfo tableInfo, CancellationToken cancellationToken = default)
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. |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<SearchCriteriaRows> |
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 Save 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 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.
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 |
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 Save 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 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.
ToArray()
Criteria storage for Selection and other Find mechanisms Collection of SearchCriteriaRow. Each element of the collection represents one row in the SearchCriteria table.
Declaration
public SearchCriteriaRow[] ToArray()
Returns
| Type | Description |
|---|---|
| SearchCriteriaRow[] |
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 Save 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 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.
ToString()
For debugging: Number of members, and the first (up to) 5 items
Declaration
public override string ToString()
Returns
| Type | Description |
|---|---|
| string |
Overrides
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 Save 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 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.