Class PreferenceRows

Not quite obsolete preference table; historical info mostly. From 6.1 this table now holds an upgrade stamp. Collection of PreferenceRow. Each element of the collection represents one row in the Preference table.

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

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

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

Methods

Add(PreferenceRow)

Add one PreferenceRow to the collection.

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

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

The index of the added PreferenceRow.

AddNew()

Add a new instance of PreferenceRow added to the collection.

Declaration
public PreferenceRow AddNew()
Returns
Type Description
PreferenceRow

A new instance of PreferenceRow added to the collection.

AddRange(IEnumerable<PreferenceRow>)

Add a range of PreferenceRow to the collection.

Declaration
public PreferenceRows AddRange(IEnumerable<PreferenceRow> rows)
Parameters
Type Name Description
IEnumerable<PreferenceRow> rows
Returns
Type Description
PreferenceRows

The updated PreferenceRows collection object.

CreateChild()

Create a new instance of PreferenceRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of PreferenceRow
Overrides

CreateNew()

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

Declaration
public static PreferenceRows CreateNew()
Returns
Type Description
PreferenceRows

A new instance of the PreferenceRows object.

Find(Predicate<PreferenceRow>)

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

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

FindAll(Predicate<PreferenceRow>)

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

Declaration
public PreferenceRows FindAll(Predicate<PreferenceRow> condition)
Parameters
Type Name Description
Predicate<PreferenceRow> condition
Returns
Type Description
PreferenceRows

ForEach(Action<PreferenceRow>)

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

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

GetFromCustomSearch(PreferenceRows.CustomSearch)

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

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

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

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

GetFromIdxType(Int16)

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

Declaration
public static PreferenceRows GetFromIdxType(short type)
Parameters
Type Name Description
Int16 type
Returns
Type Description
PreferenceRows

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

GetFromReader(SoDataReader, PreferenceTableInfo)

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

SoDataReader positioned to a valid database row.
PreferenceTableInfo tableInfo

PreferenceTableInfo 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
PreferenceRows

Remove(PreferenceRow)

Removes the given PreferenceRow from the collection

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

the PreferenceRow to be removed

ToArray()

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

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)