Class ExtTableRows

This table contains entries used for mapping an external table to an internal table (customer or cust_company) for database integration. Collection of ExtTableRow. Each element of the collection represents one row in the ExtTable table.

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

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

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

Methods

Add(ExtTableRow)

Add one ExtTableRow to the collection.

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

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

The index of the added ExtTableRow.

AddNew()

Add a new instance of ExtTableRow added to the collection.

Declaration
public ExtTableRow AddNew()
Returns
Type Description
ExtTableRow

A new instance of ExtTableRow added to the collection.

AddRange(IEnumerable<ExtTableRow>)

Add a range of ExtTableRow to the collection.

Declaration
public ExtTableRows AddRange(IEnumerable<ExtTableRow> rows)
Parameters
Type Name Description
IEnumerable<ExtTableRow> rows
Returns
Type Description
ExtTableRows

The updated ExtTableRows collection object.

CreateChild()

Create a new instance of ExtTableRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of ExtTableRow
Overrides

CreateNew()

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

Declaration
public static ExtTableRows CreateNew()
Returns
Type Description
ExtTableRows

A new instance of the ExtTableRows object.

Find(Predicate<ExtTableRow>)

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

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

FindAll(Predicate<ExtTableRow>)

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

Declaration
public ExtTableRows FindAll(Predicate<ExtTableRow> condition)
Parameters
Type Name Description
Predicate<ExtTableRow> condition
Returns
Type Description
ExtTableRows

ForEach(Action<ExtTableRow>)

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

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

GetFromCustomSearch(ExtTableRows.CustomSearch)

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

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

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

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

GetFromIdxChildTable(Int32)

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

Declaration
public static ExtTableRows GetFromIdxChildTable(int childTable)
Parameters
Type Name Description
Int32 childTable
Returns
Type Description
ExtTableRows

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

GetFromIdxExtDatasource(Int32)

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

Declaration
public static ExtTableRows GetFromIdxExtDatasource(int extDatasource)
Parameters
Type Name Description
Int32 extDatasource
Returns
Type Description
ExtTableRows

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

GetFromIdxParentTable(Int32)

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

Declaration
public static ExtTableRows GetFromIdxParentTable(int parentTable)
Parameters
Type Name Description
Int32 parentTable
Returns
Type Description
ExtTableRows

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

GetFromReader(SoDataReader, ExtTableTableInfo)

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

SoDataReader positioned to a valid database row.
ExtTableTableInfo tableInfo

ExtTableTableInfo 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
ExtTableRows

Remove(ExtTableRow)

Removes the given ExtTableRow from the collection

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

the ExtTableRow to be removed

ToArray()

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

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)