Class SatelliteRows

Definition of Satellites Collection of SatelliteRow. Each element of the collection represents one row in the Satellite table.

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

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

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

Methods

Add(SatelliteRow)

Add one SatelliteRow to the collection.

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

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

The index of the added SatelliteRow.

AddNew()

Add a new instance of SatelliteRow added to the collection.

Declaration
public SatelliteRow AddNew()
Returns
Type Description
SatelliteRow

A new instance of SatelliteRow added to the collection.

AddRange(IEnumerable<SatelliteRow>)

Add a range of SatelliteRow to the collection.

Declaration
public SatelliteRows AddRange(IEnumerable<SatelliteRow> rows)
Parameters
Type Name Description
IEnumerableSatelliteRow rows
Returns
Type Description
SatelliteRows

The updated SatelliteRows collection object.

CreateChild()

Create a new instance of SatelliteRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of SatelliteRow
Overrides

CreateNew()

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

Declaration
public static SatelliteRows CreateNew()
Returns
Type Description
SatelliteRows

A new instance of the SatelliteRows object.

Find(Predicate<SatelliteRow>)

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

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

FindAll(Predicate<SatelliteRow>)

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

Declaration
public SatelliteRows FindAll(Predicate<SatelliteRow> condition)
Parameters
Type Name Description
PredicateSatelliteRow condition
Returns
Type Description
SatelliteRows

ForEach(Action<SatelliteRow>)

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

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

GetFromCustomSearchAsync(CustomSearch, CancellationToken)

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

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

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

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

GetFromReaderAsync(SoDataReader, SatelliteTableInfo, CancellationToken)

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

SoDataReader positioned to a valid database row.
SatelliteTableInfo tableInfo

SatelliteTableInfo 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
TaskSatelliteRows

Remove(SatelliteRow)

Removes the given SatelliteRow from the collection

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

the SatelliteRow to be removed

ToArray()

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

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