Class ProductFamilyHeadingLinkRows

Heading link table for ProductFamily, for MDO item headings Collection of ProductFamilyHeadingLinkRow. Each element of the collection represents one row in the ProductFamilyHeadingLink table.

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

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

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

Methods

Add(ProductFamilyHeadingLinkRow)

Add one ProductFamilyHeadingLinkRow to the collection.

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

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

The index of the added ProductFamilyHeadingLinkRow.

AddNew()

Add a new instance of ProductFamilyHeadingLinkRow added to the collection.

Declaration
public ProductFamilyHeadingLinkRow AddNew()
Returns
Type Description
ProductFamilyHeadingLinkRow

A new instance of ProductFamilyHeadingLinkRow added to the collection.

AddRange(IEnumerable<ProductFamilyHeadingLinkRow>)

Add a range of ProductFamilyHeadingLinkRow to the collection.

Declaration
public ProductFamilyHeadingLinkRows AddRange(IEnumerable<ProductFamilyHeadingLinkRow> rows)
Parameters
Type Name Description
IEnumerable<ProductFamilyHeadingLinkRow> rows
Returns
Type Description
ProductFamilyHeadingLinkRows

The updated ProductFamilyHeadingLinkRows collection object.

CreateChild()

Create a new instance of ProductFamilyHeadingLinkRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of ProductFamilyHeadingLinkRow
Overrides

CreateNew()

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

Declaration
public static ProductFamilyHeadingLinkRows CreateNew()
Returns
Type Description
ProductFamilyHeadingLinkRows

A new instance of the ProductFamilyHeadingLinkRows object.

Find(Predicate<ProductFamilyHeadingLinkRow>)

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

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

FindAll(Predicate<ProductFamilyHeadingLinkRow>)

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

Declaration
public ProductFamilyHeadingLinkRows FindAll(Predicate<ProductFamilyHeadingLinkRow> condition)
Parameters
Type Name Description
Predicate<ProductFamilyHeadingLinkRow> condition
Returns
Type Description
ProductFamilyHeadingLinkRows

ForEach(Action<ProductFamilyHeadingLinkRow>)

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

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

GetFromCustomSearch(ProductFamilyHeadingLinkRows.CustomSearch)

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

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

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

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

GetFromIdxHeadingId(Int32)

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

Declaration
public static ProductFamilyHeadingLinkRows GetFromIdxHeadingId(int headingId)
Parameters
Type Name Description
Int32 headingId
Returns
Type Description
ProductFamilyHeadingLinkRows

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

GetFromIdxProductFamilyId(Int32)

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

Declaration
public static ProductFamilyHeadingLinkRows GetFromIdxProductFamilyId(int productFamilyId)
Parameters
Type Name Description
Int32 productFamilyId
Returns
Type Description
ProductFamilyHeadingLinkRows

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

GetFromReader(SoDataReader, ProductFamilyHeadingLinkTableInfo)

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

SoDataReader positioned to a valid database row.
ProductFamilyHeadingLinkTableInfo tableInfo

ProductFamilyHeadingLinkTableInfo 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
ProductFamilyHeadingLinkRows

Remove(ProductFamilyHeadingLinkRow)

Removes the given ProductFamilyHeadingLinkRow from the collection

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

the ProductFamilyHeadingLinkRow to be removed

ToArray()

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

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)