Class PaymentTypeHeadingLinkRows

Heading link table for PaymentType, for MDO item headings Collection of PaymentTypeHeadingLinkRow. Each element of the collection represents one row in the PaymentTypeHeadingLink table.

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

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

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

Methods

Add(PaymentTypeHeadingLinkRow)

Add one PaymentTypeHeadingLinkRow to the collection.

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

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

The index of the added PaymentTypeHeadingLinkRow.

AddNew()

Add a new instance of PaymentTypeHeadingLinkRow added to the collection.

Declaration
public PaymentTypeHeadingLinkRow AddNew()
Returns
Type Description
PaymentTypeHeadingLinkRow

A new instance of PaymentTypeHeadingLinkRow added to the collection.

AddRange(IEnumerable<PaymentTypeHeadingLinkRow>)

Add a range of PaymentTypeHeadingLinkRow to the collection.

Declaration
public PaymentTypeHeadingLinkRows AddRange(IEnumerable<PaymentTypeHeadingLinkRow> rows)
Parameters
Type Name Description
IEnumerable<PaymentTypeHeadingLinkRow> rows
Returns
Type Description
PaymentTypeHeadingLinkRows

The updated PaymentTypeHeadingLinkRows collection object.

CreateChild()

Create a new instance of PaymentTypeHeadingLinkRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of PaymentTypeHeadingLinkRow
Overrides

CreateNew()

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

Declaration
public static PaymentTypeHeadingLinkRows CreateNew()
Returns
Type Description
PaymentTypeHeadingLinkRows

A new instance of the PaymentTypeHeadingLinkRows object.

Find(Predicate<PaymentTypeHeadingLinkRow>)

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

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

FindAll(Predicate<PaymentTypeHeadingLinkRow>)

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

Declaration
public PaymentTypeHeadingLinkRows FindAll(Predicate<PaymentTypeHeadingLinkRow> condition)
Parameters
Type Name Description
Predicate<PaymentTypeHeadingLinkRow> condition
Returns
Type Description
PaymentTypeHeadingLinkRows

ForEach(Action<PaymentTypeHeadingLinkRow>)

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

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

GetFromCustomSearch(PaymentTypeHeadingLinkRows.CustomSearch)

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

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

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

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

GetFromIdxHeadingId(Int32)

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

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

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

GetFromIdxPaymentTypeId(Int32)

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

Declaration
public static PaymentTypeHeadingLinkRows GetFromIdxPaymentTypeId(int paymentTypeId)
Parameters
Type Name Description
Int32 paymentTypeId
Returns
Type Description
PaymentTypeHeadingLinkRows

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

GetFromReader(SoDataReader, PaymentTypeHeadingLinkTableInfo)

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

SoDataReader positioned to a valid database row.
PaymentTypeHeadingLinkTableInfo tableInfo

PaymentTypeHeadingLinkTableInfo 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
PaymentTypeHeadingLinkRows

Remove(PaymentTypeHeadingLinkRow)

Removes the given PaymentTypeHeadingLinkRow from the collection

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

the PaymentTypeHeadingLinkRow to be removed

ToArray()

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

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)