Class FavouriteRows

Favourite records (star-marking) Collection of FavouriteRow. Each element of the collection represents one row in the Favourite table.

Inheritance
System.Object
NestedPersist
NestedPersistFacade
NestedCollectionPersist
TableRowsBase
FavouriteRows
Implements
System.Collections.Generic.IEnumerable<INestedPersist>
System.Collections.IEnumerable
System.Collections.IList
System.Collections.ICollection
System.Collections.Specialized.INotifyCollectionChanged
System.ComponentModel.IBindingList
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class FavouriteRows : TableRowsBase, INestedPersist, IEnumerable<INestedPersist>, ISoCollection, IEnumerable, IList, ICollection, 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 FavouriteRow to it, and use methods like to operate on the whole collection.
  • You can create a (nested) FavouriteRows FavouriteRows.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(FavouriteRows.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 FavouriteRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, FavouriteTableInfo) 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 FavouriteRow given its index in the collection.

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

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

Methods

Add(FavouriteRow)

Add one FavouriteRow to the collection.

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

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

The index of the added FavouriteRow.

AddNew()

Add a new instance of FavouriteRow added to the collection.

Declaration
public FavouriteRow AddNew()
Returns
Type Description
FavouriteRow

A new instance of FavouriteRow added to the collection.

AddRange(IEnumerable<FavouriteRow>)

Add a range of FavouriteRow to the collection.

Declaration
public FavouriteRows AddRange(IEnumerable<FavouriteRow> rows)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<FavouriteRow> rows
Returns
Type Description
FavouriteRows

The updated FavouriteRows collection object.

CreateChild()

Create a new instance of FavouriteRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of FavouriteRow
Overrides

CreateNew()

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

Declaration
public static FavouriteRows CreateNew()
Returns
Type Description
FavouriteRows

A new instance of the FavouriteRows object.

Find(Predicate<FavouriteRow>)

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

Declaration
public FavouriteRow Find(Predicate<FavouriteRow> condition)
Parameters
Type Name Description
System.Predicate<FavouriteRow> condition
Returns
Type Description
FavouriteRow

FindAll(Predicate<FavouriteRow>)

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

Declaration
public FavouriteRows FindAll(Predicate<FavouriteRow> condition)
Parameters
Type Name Description
System.Predicate<FavouriteRow> condition
Returns
Type Description
FavouriteRows

ForEach(Action<FavouriteRow>)

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

Declaration
public void ForEach(Action<FavouriteRow> whatToDo)
Parameters
Type Name Description
System.Action<FavouriteRow> whatToDo

GetFromCustomSearch(FavouriteRows.CustomSearch)

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

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

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

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

GetFromIdxRecordId(Int32)

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

Declaration
public static FavouriteRows GetFromIdxRecordId(int recordId)
Parameters
Type Name Description
System.Int32 recordId
Returns
Type Description
FavouriteRows

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

GetFromIdxRecordIdAssociateId(Int32, Int32)

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

Declaration
public static FavouriteRows GetFromIdxRecordIdAssociateId(int recordId, int associateId)
Parameters
Type Name Description
System.Int32 recordId
System.Int32 associateId
Returns
Type Description
FavouriteRows

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

GetFromIdxRecordIdAssociateIdTableId(Int32, Int32, Int16)

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

Declaration
public static FavouriteRows GetFromIdxRecordIdAssociateIdTableId(int recordId, int associateId, short tableId)
Parameters
Type Name Description
System.Int32 recordId
System.Int32 associateId
System.Int16 tableId
Returns
Type Description
FavouriteRows

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

GetFromReader(SoDataReader, FavouriteTableInfo)

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

SoDataReader positioned to a valid database row.
FavouriteTableInfo tableInfo

FavouriteTableInfo 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
FavouriteRows

Remove(FavouriteRow)

Removes the given FavouriteRow from the collection

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

the FavouriteRow to be removed

ToArray()

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

ToString()

For debugging: Number of members, and the first (up to) 5 items

Declaration
public override string ToString()
Returns
Type Description
System.String

Implements

System.Collections.Generic.IEnumerable<>
System.Collections.IEnumerable
System.Collections.IList
System.Collections.ICollection
System.Collections.Specialized.INotifyCollectionChanged
System.ComponentModel.IBindingList

Extension Methods

EnumUtil.MapEnums<From, To>(From)