Class CacheTablesRows

Specifies which tables should be cached to local files (or otherwise), generally these are the lists and other low-frequency-of-change tables. Contains the ID of any tables cached in SOCache. The files are binary and called <tablename>.bin. <Shift>+<F5> throws all cache files. Collection of CacheTablesRow. Each element of the collection represents one row in the CacheTables table.

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

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

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

Methods

Add(CacheTablesRow)

Add one CacheTablesRow to the collection.

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

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

The index of the added CacheTablesRow.

AddNew()

Add a new instance of CacheTablesRow added to the collection.

Declaration
public CacheTablesRow AddNew()
Returns
Type Description
CacheTablesRow

A new instance of CacheTablesRow added to the collection.

AddRange(IEnumerable<CacheTablesRow>)

Add a range of CacheTablesRow to the collection.

Declaration
public CacheTablesRows AddRange(IEnumerable<CacheTablesRow> rows)
Parameters
Type Name Description
IEnumerable<CacheTablesRow> rows
Returns
Type Description
CacheTablesRows

The updated CacheTablesRows collection object.

CreateChild()

Create a new instance of CacheTablesRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of CacheTablesRow
Overrides

CreateNew()

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

Declaration
public static CacheTablesRows CreateNew()
Returns
Type Description
CacheTablesRows

A new instance of the CacheTablesRows object.

Find(Predicate<CacheTablesRow>)

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

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

FindAll(Predicate<CacheTablesRow>)

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

Declaration
public CacheTablesRows FindAll(Predicate<CacheTablesRow> condition)
Parameters
Type Name Description
Predicate<CacheTablesRow> condition
Returns
Type Description
CacheTablesRows

ForEach(Action<CacheTablesRow>)

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

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

GetFromCustomSearch(CacheTablesRows.CustomSearch)

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

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

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

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

GetFromIdxTableId(Int16)

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

Declaration
public static CacheTablesRows GetFromIdxTableId(short tableId)
Parameters
Type Name Description
Int16 tableId
Returns
Type Description
CacheTablesRows

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

GetFromReader(SoDataReader, CacheTablesTableInfo)

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

SoDataReader positioned to a valid database row.
CacheTablesTableInfo tableInfo

CacheTablesTableInfo 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
CacheTablesRows

Remove(CacheTablesRow)

Removes the given CacheTablesRow from the collection

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

the CacheTablesRow to be removed

ToArray()

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

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)