Class ImportRelationRows

Relations between import objects Collection of ImportRelationRow. Each element of the collection represents one row in the ImportRelation table.

Inheritance
object
NestedPersist
NestedPersistFacade
NestedCollectionPersist
TableRowsBase
ImportRelationRows
Inherited Members
Namespace: SuperOfficeCRMRows
Assembly: SoDataBase.dll
Syntax
public class ImportRelationRows : 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 ImportRelationRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) ImportRelationRows ImportRelationRows.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.
Unique indexes are handled through the ImportRelationRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.ImportRelationRows.GetFromReader 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

this[int]

Get a ImportRelationRow given its index in the collection.

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

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

Methods

Add(ImportRelationRow)

Add one ImportRelationRow to the collection.

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

An instance of ImportRelationRow to be added to the collection.
Returns
Type Description
int

The index of the added ImportRelationRow.

AddNew()

Add a new instance of ImportRelationRow added to the collection.

Declaration
public ImportRelationRow AddNew()
Returns
Type Description
ImportRelationRow

A new instance of ImportRelationRow added to the collection.

AddRange(IEnumerable<ImportRelationRow>)

Add a range of ImportRelationRow to the collection.

Declaration
public ImportRelationRows AddRange(IEnumerable<ImportRelationRow> rows)
Parameters
Type Name Description
IEnumerableImportRelationRow rows
Returns
Type Description
ImportRelationRows

The updated ImportRelationRows collection object.

CreateChild()

Create a new instance of ImportRelationRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of ImportRelationRow
Overrides

CreateNew()

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

Declaration
public static ImportRelationRows CreateNew()
Returns
Type Description
ImportRelationRows

A new instance of the ImportRelationRows object.

Find(Predicate<ImportRelationRow>)

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

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

FindAll(Predicate<ImportRelationRow>)

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

Declaration
public ImportRelationRows FindAll(Predicate<ImportRelationRow> condition)
Parameters
Type Name Description
PredicateImportRelationRow condition
Returns
Type Description
ImportRelationRows

ForEach(Action<ImportRelationRow>)

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

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

GetFromCustomSearchAsync(CustomSearch, CancellationToken)

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

Declaration
public static Task<ImportRelationRows> GetFromCustomSearchAsync(ImportRelationRows.CustomSearch query, CancellationToken cancellationToken = default)
Parameters
Type Name Description
ImportRelationRowsCustomSearch query

The custom search to execute against the database
CancellationToken cancellationToken
Returns
Type Description
TaskImportRelationRows

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

GetFromIdxSourceAsync(int, CancellationToken)

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

Declaration
public static Task<ImportRelationRows> GetFromIdxSourceAsync(int source, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int source
CancellationToken cancellationToken
Returns
Type Description
TaskImportRelationRows

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

GetFromIdxTargetAsync(int, CancellationToken)

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

Declaration
public static Task<ImportRelationRows> GetFromIdxTargetAsync(int target, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int target
CancellationToken cancellationToken
Returns
Type Description
TaskImportRelationRows

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

GetFromReaderAsync(SoDataReader, ImportRelationTableInfo, CancellationToken)

Create a new instance of the ImportRelationRows 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 ImportRelationRow 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<ImportRelationRows> GetFromReaderAsync(SoDataReader reader, ImportRelationTableInfo tableInfo, CancellationToken cancellationToken = default)
Parameters
Type Name Description
SoDataReader reader

SoDataReader positioned to a valid database row.
ImportRelationTableInfo tableInfo

ImportRelationTableInfo 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
TaskImportRelationRows

Remove(ImportRelationRow)

Removes the given ImportRelationRow from the collection

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

the ImportRelationRow to be removed

ToArray()

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

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