Class PriorityHeadingLinkRows

Heading link table for Priority, for MDO headers Collection of PriorityHeadingLinkRow. Each element of the collection represents one row in the PriorityHeadingLink table.

Inheritance
object
NestedPersist
NestedPersistFacade
NestedCollectionPersist
TableRowsBase
PriorityHeadingLinkRows
Inherited Members
Namespace: SuperOfficeCRMRows
Assembly: SoDataBase.dll
Syntax
public class PriorityHeadingLinkRows : TableRowsBase, INestedPersist, IEnumerable<INestedPersist>, INotifyCollectionChanged, IBindingList, IList, ICollection, IEnumerable
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 PriorityHeadingLinkRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) PriorityHeadingLinkRows PriorityHeadingLinkRows.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 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 PriorityHeadingLinkRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.PriorityHeadingLinkRows.GetFromReader 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

this[int]

Get a PriorityHeadingLinkRow given its index in the collection.

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

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

Methods

Add(PriorityHeadingLinkRow)

Add one PriorityHeadingLinkRow to the collection.

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

An instance of PriorityHeadingLinkRow to be added to the collection.
Returns
Type Description
int

The index of the added PriorityHeadingLinkRow.

AddNew()

Add a new instance of PriorityHeadingLinkRow added to the collection.

Declaration
public PriorityHeadingLinkRow AddNew()
Returns
Type Description
PriorityHeadingLinkRow

A new instance of PriorityHeadingLinkRow added to the collection.

AddRange(IEnumerable<PriorityHeadingLinkRow>)

Add a range of PriorityHeadingLinkRow to the collection.

Declaration
public PriorityHeadingLinkRows AddRange(IEnumerable<PriorityHeadingLinkRow> rows)
Parameters
Type Name Description
IEnumerablePriorityHeadingLinkRow rows
Returns
Type Description
PriorityHeadingLinkRows

The updated PriorityHeadingLinkRows collection object.

CreateChild()

Create a new instance of PriorityHeadingLinkRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of PriorityHeadingLinkRow
Overrides

CreateNew()

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

Declaration
public static PriorityHeadingLinkRows CreateNew()
Returns
Type Description
PriorityHeadingLinkRows

A new instance of the PriorityHeadingLinkRows object.

Find(Predicate<PriorityHeadingLinkRow>)

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

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

FindAll(Predicate<PriorityHeadingLinkRow>)

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

Declaration
public PriorityHeadingLinkRows FindAll(Predicate<PriorityHeadingLinkRow> condition)
Parameters
Type Name Description
PredicatePriorityHeadingLinkRow condition
Returns
Type Description
PriorityHeadingLinkRows

ForEach(Action<PriorityHeadingLinkRow>)

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

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

GetFromCustomSearchAsync(CustomSearch, CancellationToken)

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

Declaration
public static Task<PriorityHeadingLinkRows> GetFromCustomSearchAsync(PriorityHeadingLinkRows.CustomSearch query, CancellationToken cancellationToken = default)
Parameters
Type Name Description
PriorityHeadingLinkRowsCustomSearch query

The custom search to execute against the database
CancellationToken cancellationToken
Returns
Type Description
TaskPriorityHeadingLinkRows

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

GetFromIdxHeadingIdAsync(int, CancellationToken)

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

Declaration
public static Task<PriorityHeadingLinkRows> GetFromIdxHeadingIdAsync(int headingId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int headingId
CancellationToken cancellationToken
Returns
Type Description
TaskPriorityHeadingLinkRows

Row object that represents the result of the search. IsNew 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 PriorityHeadingLink table. Non-unique indexes have corresponding inner classes and methods in the PriorityHeadingLinkRows collection, since they may return more than one row.

GetFromIdxPriorityIdAsync(int, CancellationToken)

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

Declaration
public static Task<PriorityHeadingLinkRows> GetFromIdxPriorityIdAsync(int priorityId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
int priorityId
CancellationToken cancellationToken
Returns
Type Description
TaskPriorityHeadingLinkRows

Row object that represents the result of the search. IsNew 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 PriorityHeadingLink table. Non-unique indexes have corresponding inner classes and methods in the PriorityHeadingLinkRows collection, since they may return more than one row.

GetFromReaderAsync(SoDataReader, PriorityHeadingLinkTableInfo, CancellationToken)

Create a new instance of the PriorityHeadingLinkRows 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 PriorityHeadingLinkRow 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 Task<PriorityHeadingLinkRows> GetFromReaderAsync(SoDataReader reader, PriorityHeadingLinkTableInfo tableInfo, CancellationToken cancellationToken = default)
Parameters
Type Name Description
SoDataReader reader

SoDataReader positioned to a valid database row.
PriorityHeadingLinkTableInfo tableInfo

PriorityHeadingLinkTableInfo 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.
CancellationToken cancellationToken
Returns
Type Description
TaskPriorityHeadingLinkRows

Remove(PriorityHeadingLinkRow)

Removes the given PriorityHeadingLinkRow from the collection

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

the PriorityHeadingLinkRow to be removed

ToArray()

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

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