Class TicketRelationDefRows

Ticket relation definition Collection of TicketRelationDefRow. Each element of the collection represents one row in the TicketRelationDef table.

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

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

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

Methods

Add(TicketRelationDefRow)

Add one TicketRelationDefRow to the collection.

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

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

The index of the added TicketRelationDefRow.

AddNew()

Add a new instance of TicketRelationDefRow added to the collection.

Declaration
public TicketRelationDefRow AddNew()
Returns
Type Description
TicketRelationDefRow

A new instance of TicketRelationDefRow added to the collection.

AddRange(IEnumerable<TicketRelationDefRow>)

Add a range of TicketRelationDefRow to the collection.

Declaration
public TicketRelationDefRows AddRange(IEnumerable<TicketRelationDefRow> rows)
Parameters
Type Name Description
IEnumerableTicketRelationDefRow rows
Returns
Type Description
TicketRelationDefRows

The updated TicketRelationDefRows collection object.

CreateChild()

Create a new instance of TicketRelationDefRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of TicketRelationDefRow
Overrides

CreateNew()

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

Declaration
public static TicketRelationDefRows CreateNew()
Returns
Type Description
TicketRelationDefRows

A new instance of the TicketRelationDefRows object.

Find(Predicate<TicketRelationDefRow>)

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

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

FindAll(Predicate<TicketRelationDefRow>)

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

Declaration
public TicketRelationDefRows FindAll(Predicate<TicketRelationDefRow> condition)
Parameters
Type Name Description
PredicateTicketRelationDefRow condition
Returns
Type Description
TicketRelationDefRows

ForEach(Action<TicketRelationDefRow>)

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

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

GetFromCustomSearchAsync(CustomSearch, CancellationToken)

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

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

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

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

GetFromReaderAsync(SoDataReader, TicketRelationDefTableInfo, CancellationToken)

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

SoDataReader positioned to a valid database row.
TicketRelationDefTableInfo tableInfo

TicketRelationDefTableInfo 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
TaskTicketRelationDefRows

Remove(TicketRelationDefRow)

Removes the given TicketRelationDefRow from the collection

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

the TicketRelationDefRow to be removed

ToArray()

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

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